CLI reference

Full Method CLI

npm install -g https://app.withmethod.ai/downloads/withmethod-sdk-latest.tgz
method --version
method authoring
method authoring all
method COMMAND --help

Node.js 22+ is required. The SDK download contains MIT source and its pinned public runtime dependency. The package is distributed through the Method download service; do not assume it is on the npm registry.

Task	Commands
Read the grammar and guide	`schema`, `authoring`
Edit local drafts	`init`, `show`, `set`, `remove`, `step add/update/remove/move`, `check set/remove`, `diff`
Check definition and local setup	`validate FILE`
Sign in and manage computers	`status`, `login`, `logout`, `devices`, `revoke`
Save and read versions	`create`, `save`, `get`, `update`, `list`, `steps`, `step`
Execute and recover	`run FILE_OR_ID`, `--resume`, `--retry`, `--human`
Check and prepare local tools	`doctor`, `setup`
Control a background run	`watch`, `wait`, `cancel`
Inspect and upload records	`inspect RUN_DIRECTORY`, `runs`, `logs`, `sync RUN_DIRECTORY`
Convert an older draft	`migrate`
Report script progress	`progress`

init creates an incomplete draft. Add at least one step and a valid result before validation. Current checks use structured exact, script, or agent objects:

method check set task.method copy --json '{"equals":{"actual":"copied","expected":"message"}}'
method set task.method /steps/copy/do/prompt --text-file instructions.txt

The check example assumes a step named copy, a local input named message, and an output named copied. Use method schema check for the accepted forms. Plain-text checks belong to older formats; current agent checks put criteria in prompt. Current runs exit 0 on completion, 1 on failure, and 2 when human input is needed. Read the returned status and saved evidence.

Command ownership

The public SDK owns method. Runtime 0.5.0 no longer installs method3. SDK 0.7.0 removes the workflow, sdk, method-run, and workflow-bridge aliases. Python keeps withmethod; method-python and workflow-corp are removed. method-bridge is an internal Python transport. Runtime contributors can use node src/cli.js inside method-spec to test its validator and executor. This is a development harness, not a second installed product CLI.

Start

Method lifecycle

Full Method CLI

Command ownership

​Full Method CLI

​Command ownership

Full Method CLI

Command ownership