Skip to main content

Reference

The Dagger CLI provides a command-line interface to Dagger.

Usage​

dagger [options] [command]

Options​

The options below can be used with all CLI commands.

OptionDescription
--debugShow Buildkitd debug logs
-h, --helpShow help text
--workdirDefine the host working directory (default .)
------

Commands​

dagger completion​

Generate the autocompletion script for dagger for the specified shell. Available shells are bash, fish, zsh and powershell.

note

You will need to start a new shell for this setup to take effect.

Usage​

dagger completion [shell]

Examples​

Load completions for every new session on Linux:

dagger completion bash > /etc/bash_completion.d/dagger

To load completions for every new session on macOS:

dagger completion bash > $(brew --prefix)/etc/bash_completion.d/dagger

dagger run​

Executes the specified command in a Dagger session. DAGGER_SESSION_PORT and DAGGER_SESSION_TOKEN will be injected automatically.

Usage​

dagger run [command]

Example​

Make an HTTP request using curl:

dagger run -- sh -c 'curl \
  -u $DAGGER_SESSION_TOKEN: \
  -H "content-type:application/json" \
  -d "{\"query\":\"{container{id}}\"}" \
  http://127.0.0.1:$DAGGER_SESSION_PORT/query'

dagger help​

Usage​

dagger help [command]

Retrieve detailed help text for any command in the application.

Example​

Obtain help for the dagger query command:

dagger help query

dagger query​

Send API queries to the Dagger Engine. When no file provider, read query string from standard input.

Usage​

dagger query [--doc file] [--var string] [--var-json string] [query]

Options​

OptionDescription
--docRead query from file
--varRead query from string
--var-jsonRead query from JSON string
------

Example​

Execute an API query:

dagger query <<EOF
{
  container {
    from(address:"hello-world") {
      exec(args:["/hello"]) {
        stdout {
          contents
        }
      }
    }
  }
}
EOF

dagger version​

Display version.

Usage​

dagger version

Example​

Display the current version:

dagger version