Skip to main content

CLI Reference

Global Options

wendell --version
wendell --help

wendell register

Register a local runner and store credentials.

wendell register

Options:

OptionDescription
--api-urlOverride the Wendell API URL. Production is the default.
--emailWendell account email.
--agentAgent display name for this runner.
--providerModel or runtime provider.
--modelModel or runtime name.
--computer-nameRunner machine name.
--password-stdinRead password from stdin.

wendell login

Store an existing API key.

printf "%s\n" "$WENDELL_INKPASS_API_KEY" | wendell login \
--api-key-stdin \
--validate

wendell whoami

Show the active identity.

wendell whoami

wendell playbook create

Create a Playbook draft.

wendell playbook create \
--name "Refund Agent Regression" \
--workflow-summary "A support agent evaluates refunds." \
--source ./refund-playbook.md \
--project-ref refund-agent \
--domain customer-support-refunds \
--extract

Options:

OptionDescription
--nameRequired. Playbook or test suite name.
--workflow-summaryRequired. Short workflow description.
--sourceSource file to ingest. Can be repeated.
--source-textInline source material.
--project-refCustomer or project reference.
--org-refOrganization reference used when auth is unscoped.
--created-byCreator label. Defaults to wendell-cli.
--domainWorkflow domain.
--extractImmediately generate the first Playbook summary.
--jsonPrint JSON output.

wendell playbook review

Review extracted Playbook primitives and questions.

wendell playbook review wdraft_abc123

wendell playbook apply

Apply a review patch.

wendell playbook apply wdraft_abc123 \
--file ./review.json

wendell playbook approve

Approve the latest Playbook summary.

wendell playbook approve wdraft_abc123 \
--reviewer "you@example.com" \
--generate-suite

wendell suites list

List accessible published suites.

wendell suites list

wendell suites generate

Generate a suite candidate from an approved draft.

wendell suites generate \
--draft wdraft_abc123

wendell suites publish

Publish a generated suite candidate.

wendell suites publish \
--draft wdraft_abc123

wendell suites show

Show a published suite that your runner can access.

wendell suites show refund-agent-regression

wendell suites configure

Write wendell.toml and an adapter template for a hosted suite.

wendell suites configure \
--suite refund-agent-regression \
--project refund-agent

Options:

OptionDescription
--suiteRequired. Published test suite slug.
--projectProject slug to write into wendell.toml. Defaults to the suite slug.
--configConfig path to write. Defaults to wendell.toml.
--adapterAdapter template path to write. Defaults to scripts/wendell_agent_adapter.py.
--agent-commandAgent command to write into wendell.toml. Defaults to python <adapter>.
--forceOverwrite existing config or adapter files.

wendell run

Run a local agent against a published suite.

wendell run \
--suite refund-agent-regression \
--config ./wendell.toml

Options:

OptionDescription
--suiteRequired. Published test suite slug.
--configPath to wendell.toml. Defaults to wendell.toml.
--api-urlOverride the Wendell API URL. Production is the default.
--jsonPrint JSON output.

wendell run evaluates configured gates after uploading the run. In advisory mode, failed gates are printed and the command exits successfully. In blocking mode, failed gates return a nonzero exit code for CI.

wendell runs watch

Fetch the current hosted status for a run.

wendell runs watch run_abc123

wendell runs report

Fetch the private hosted report for a run.

wendell runs report run_abc123