Skip to content

CLI Commands#

Interact with the Dreadnode platform

Usage:

$ dreadnode [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • agent: Interact with Strike agents
  • challenge: Interact with Crucible challenges
  • login: Authenticate to the platform.
  • model: Manage user-defined inference models
  • profile: Manage server profiles
  • refresh: Refresh data for the active server profile.
  • version: Show versions and exit.

dreadnode agent#

Interact with Strike agents

Usage:

$ dreadnode agent [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • clone: Clone a github repository
  • deploy: Start a new run using the latest active...
  • init: Initialize a new agent project
  • latest: Show the latest run of the active agent
  • links: List available agent links
  • models: List available models for the current (or...
  • push: Push a new version of the active agent
  • runs: List runs for the active agent
  • show: Show the status of the active agent
  • strikes: List available strikes
  • switch: Switch to a different agent link
  • templates: Manage Agent templates
  • versions: List historical versions of the active agent

dreadnode agent clone#

Clone a github repository

Usage:

$ dreadnode agent clone [OPTIONS] REPO [TARGET]

Arguments:

  • REPO: Repository name or URL [required]
  • [TARGET]: The target directory

Options:

  • --help: Show this message and exit.

dreadnode agent deploy#

Start a new run using the latest active agent version

Usage:

$ dreadnode agent deploy [OPTIONS]

Options:

  • -m, --model TEXT: The inference model to use for this run
  • -d, --dir DIRECTORY: The agent directory [default: .]
  • -e, --env-var TEXT: Environment vars to override for this run (key=value)
  • -p, --param TEXT: Define custom parameters for this run (key = value in toml syntax or @filename.toml for multiple values)
  • -c, --command TEXT: Override the container command for this run.
  • -s, --strike TEXT: The strike to use for this run
  • -w, --watch: Watch the run status [default: True]
  • --help: Show this message and exit.

dreadnode agent init#

Initialize a new agent project

Usage:

$ dreadnode agent init [OPTIONS] STRIKE

Arguments:

  • STRIKE: The target strike [required]

Options:

  • -d, --dir DIRECTORY: The directory to initialize [default: .]
  • -n, --name TEXT: The project name (used for container naming)
  • -t, --template TEXT: The template to use for the agent
  • -s, --source TEXT: Initialize the agent using a custom template from a github repository, ZIP archive URL or local folder
  • -p, --path TEXT: If --source has been provided, use --path to specify a subfolder to initialize from
  • --help: Show this message and exit.

dreadnode agent latest#

Show the latest run of the active agent

Usage:

$ dreadnode agent latest [OPTIONS]

Options:

  • -d, --dir DIRECTORY: The agent directory [default: .]
  • -v, --verbose: Show detailed run information
  • -l, --logs: Show all container logs for the run (only in verbose mode)
  • --raw: Show raw JSON output
  • --help: Show this message and exit.

List available agent links

Usage:

$ dreadnode agent links [OPTIONS] [DIRECTORY]

Arguments:

  • [DIRECTORY]: The agent directory [default: .]

Options:

  • --help: Show this message and exit.

dreadnode agent models#

List available models for the current (or specified) strike

Usage:

$ dreadnode agent models [OPTIONS] [DIRECTORY]

Arguments:

  • [DIRECTORY]: The agent directory [default: .]

Options:

  • -s, --strike TEXT: The strike to query
  • --help: Show this message and exit.

dreadnode agent push#

Push a new version of the active agent

Usage:

$ dreadnode agent push [OPTIONS]

Options:

  • -d, --dir DIRECTORY: The agent directory [default: .]
  • -t, --tag TEXT: The tag to use for the image
  • -e, --env-var TEXT: Environment vars to use when executing the image (key=value)
  • -n, --new: Create a new agent instead of a new version
  • -m, --message TEXT: Notes for the new version
  • -r, --rebuild: Force rebuild the agent image
  • --help: Show this message and exit.

dreadnode agent runs#

List runs for the active agent

Usage:

$ dreadnode agent runs [OPTIONS] [DIRECTORY]

Arguments:

  • [DIRECTORY]: The agent directory [default: .]

Options:

  • --help: Show this message and exit.

dreadnode agent show#

Show the status of the active agent

Usage:

$ dreadnode agent show [OPTIONS]

Options:

  • -d, --dir DIRECTORY: The agent directory [default: .]
  • --help: Show this message and exit.

dreadnode agent strikes#

List available strikes

Usage:

$ dreadnode agent strikes [OPTIONS]

Options:

  • --help: Show this message and exit.

dreadnode agent switch#

Switch to a different agent link

Usage:

$ dreadnode agent switch [OPTIONS] AGENT_OR_PROFILE [DIRECTORY]

Arguments:

  • AGENT_OR_PROFILE: Agent key/id or profile name [required]
  • [DIRECTORY]: The agent directory [default: .]

Options:

  • --help: Show this message and exit.

dreadnode agent templates#

Manage Agent templates

Usage:

$ dreadnode agent templates [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • install: Install a template pack
  • show|list: List available agent templates with their...

dreadnode agent templates install#

Install a template pack

Usage:

$ dreadnode agent templates install [OPTIONS] [SOURCE]

Arguments:

  • [SOURCE]: The source of the template pack [default: dreadnode/basic-agents]

Options:

  • --help: Show this message and exit.

dreadnode agent templates show|list#

List available agent templates with their descriptions

Usage:

$ dreadnode agent templates show|list [OPTIONS]

Options:

  • --help: Show this message and exit.

dreadnode agent versions#

List historical versions of the active agent

Usage:

$ dreadnode agent versions [OPTIONS] [DIRECTORY]

Arguments:

  • [DIRECTORY]: The agent directory [default: .]

Options:

  • --help: Show this message and exit.

dreadnode challenge#

Interact with Crucible challenges

Usage:

$ dreadnode challenge [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • artifact: Download a challenge artifact.
  • list: List challenges
  • submit-flag: Submit a flag to a challenge

dreadnode challenge artifact#

Download a challenge artifact.

Usage:

$ dreadnode challenge artifact [OPTIONS] CHALLENGE_ID ARTIFACT_NAME

Arguments:

  • CHALLENGE_ID: Challenge name [required]
  • ARTIFACT_NAME: Artifact name [required]

Options:

  • -o, --output DIRECTORY: The directory to save the artifact to. [default: .]
  • --help: Show this message and exit.

dreadnode challenge list#

List challenges

Usage:

$ dreadnode challenge list [OPTIONS]

Options:

  • --sort-by [none|difficulty|status|title|authors|tags]: The sorting order [default: none]
  • --sort-order [ascending|descending]: The sorting order [default: ascending]
  • --help: Show this message and exit.

dreadnode challenge submit-flag#

Submit a flag to a challenge

Usage:

$ dreadnode challenge submit-flag [OPTIONS] CHALLENGE FLAG

Arguments:

  • CHALLENGE: Challenge name [required]
  • FLAG: Challenge flag [required]

Options:

  • --help: Show this message and exit.

dreadnode login#

Authenticate to the platform.

Usage:

$ dreadnode login [OPTIONS]

Options:

  • -s, --server TEXT: URL of the server
  • -p, --profile TEXT: Profile alias to assign / update
  • --help: Show this message and exit.

dreadnode model#

Manage user-defined inference models

Usage:

$ dreadnode model [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • add: Add a new inference model
  • forget: Remove an user inference model
  • show|list: List all configured models

dreadnode model add#

Add a new inference model

Usage:

$ dreadnode model add [OPTIONS]

Options:

  • --id TEXT: Identifier for referencing this model [required]
  • -g, --generator-id TEXT: Rigging (LiteLLM) generator id [required]
  • -k, --api-key TEXT: API key for the inference provider (supports $ENV_VAR syntax) [required]
  • -n, --name TEXT: Friendly name
  • -p, --provider TEXT: Provider name
  • -u, --update: Update an existing model if it exists
  • --help: Show this message and exit.

If $ENV_VAR syntax is used for the api key, it will be replaced with the environment value when used.

dreadnode model forget#

Remove an user inference model

Usage:

$ dreadnode model forget [OPTIONS] ID

Arguments:

  • ID: Model to remove [required]

Options:

  • --help: Show this message and exit.

dreadnode model show|list#

List all configured models

Usage:

$ dreadnode model show|list [OPTIONS]

Options:

  • --help: Show this message and exit.

dreadnode profile#

Manage server profiles

Usage:

$ dreadnode profile [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • forget: Remove a server profile
  • show|list: List all server profiles
  • switch: Set the active server profile

dreadnode profile forget#

Remove a server profile

Usage:

$ dreadnode profile forget [OPTIONS] PROFILE

Arguments:

  • PROFILE: Profile of the server to remove [required]

Options:

  • --help: Show this message and exit.

dreadnode profile show|list#

List all server profiles

Usage:

$ dreadnode profile show|list [OPTIONS]

Options:

  • --help: Show this message and exit.

dreadnode profile switch#

Set the active server profile

Usage:

$ dreadnode profile switch [OPTIONS] PROFILE

Arguments:

  • PROFILE: Profile to switch to [required]

Options:

  • --help: Show this message and exit.

dreadnode refresh#

Refresh data for the active server profile.

Usage:

$ dreadnode refresh [OPTIONS]

Options:

  • --help: Show this message and exit.

dreadnode version#

Show versions and exit.

Usage:

$ dreadnode version [OPTIONS]

Options:

  • --help: Show this message and exit.