Quickstart

In this guide, you will create a basic Dagger configuration for your project, and run your first Checks locally.

Complete Try Dagger before you start.

Dagger configures the project that you run it in. Run every command in this guide from your project root.

Install modules

Scan the project for suitable modules:

dagger setup

Select the modules that match your project. Then select Install selected.

The first install creates dagger.toml at the repository root. This file holds the workspace configuration for everyone who uses the repository.

If Dagger migrates an old configuration, run dagger setup again.

If Dagger reports No recommendations, search for a module by the name of a tool in your project. For example, if the project uses ESLint:

dagger search eslint
dagger install github.com/dagger/eslint

Most modules use suitable default settings. List the available settings:

dagger settings

Change a setting when the default does not match the project. For example, if you installed ESLint and the project uses Yarn:

dagger settings eslint packageManager yarn

Settings are stored in dagger.toml, so they apply to all users of the workspace.

List the workspace Generators:

dagger generate -l

If the list is not empty, run them:

dagger generate

Review the changes. Apply them when requested.

List the Checks:

dagger check -l

If no Check validates your project, install another suitable module. If at least one does, run the Checks:

dagger check

You are done when at least one Check runs and all Checks pass.