Skip to content

Workflows

Compile, run, and inspect multi-step agent workflows from the Dreadnode CLI.

Terminal window
$ dn workflow <command>

Authored multi-step agent pipelines: definitions, runs, and approvals.

Aliases: defs

Terminal window
$ dn workflow definitions

List compiled workflow definitions in your organization.

Options

  • --capability — Only workflows from this capability.
  • --name — Only workflows with this name.
  • --agent — Only workflows whose steps call this agent.
  • --limit (default 50) — Maximum results to show.
  • --json (default False) — Output as JSON.
Terminal window
$ dn workflow get <definition-id>

Show a workflow definition.

Options

  • <definition-id>, --definition-id (Required) — The definition to show.
  • --topology (default False) — Print the full compiled topology document.
  • --json (default False) — Output as JSON.
Terminal window
$ dn workflow run --project-id <str> <definition-id>

Start a workflow run.

Options

  • <definition-id>, --definition-id (Required) — The compiled definition to run.
  • --project-id (Required) — Project the run belongs to.
  • --input — Workflow input as key=value; repeatable. Values are JSON-decoded when possible, so max_steps=200 is an int.
  • --local (default False) — Execute here, in this process, shipping facts to the platform as it goes. Without it the selected runtime executes the workflow.
  • --runtime-id — Runtime that owns remote execution. Required unless --local.
  • --runtime-url — Runtime to run agents against when using --local.
  • --json (default False) — Output as JSON.

Aliases: ls

Terminal window
$ dn workflow list --project-id <str>

Show workflow runs in a project.

Options

  • --project-id (Required) — Project to list runs for.
  • --definition-id — Only runs of this definition.
  • --status — Filter by run status.
  • --limit (default 50) — Maximum results to show.
  • --json (default False) — Output as JSON.
Terminal window
$ dn workflow status <run-id>

Show a run with its node statuses.

Options

  • <run-id>, --run-id (Required) — The run to show.
  • --json (default False) — Output as JSON.
Terminal window
$ dn workflow cancel --project-id <str> <run-id>

Cancel a workflow before a runtime claims it.

Options

  • <run-id>, --run-id (Required) — The run to cancel.
  • --project-id (Required) — Project containing the run.
  • --force (default False) — Skip the confirmation prompt.
Terminal window
$ dn workflow approvals --project-id <str>

List approvals waiting on a decision.

V1 uses this queue for in-agent tool calls. Authored workflow gates are rejected when the run is created.

Options

  • --project-id (Required) — Project to list approvals for.
  • --limit (default 50) — Maximum results to show.
  • --json (default False) — Output as JSON.
Terminal window
$ dn workflow approve <approval-id>

Allow a pending approval.

Options

  • <approval-id>, --approval-id (Required) — The approval to allow.
  • --session (default False) — Allow for the rest of the session rather than once.
  • --note — Optional note recorded with the decision.
Terminal window
$ dn workflow deny <approval-id>

Deny a pending approval.

Options

  • <approval-id>, --approval-id (Required) — The approval to deny.
  • --note — Optional note recorded with the decision.