> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withmethod.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI reference

> Use the Method CLI from the public SDK.

## Full Method CLI

```sh theme={null}
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.

| Command        | Purpose                                                                          |
| -------------- | -------------------------------------------------------------------------------- |
| `doctor`       | Check Node and configured runtime access without running a Method.               |
| `inspect`      | Export saved execution evidence.                                                 |
| `prompt`       | Read the document as instructions.                                               |
| `bind`         | Save a named input location or connection.                                       |
| `state`        | Read or explicitly enable shared account state.                                  |
| `wait`         | Reconnect to the same local worker.                                              |
| `run-status`   | Read worker status without waiting.                                              |
| `cancel`       | Stop a local run process.                                                        |
| `progress`     | Report public progress from a running script or relay a child Codex JSON stream. |
| `authoring`    | Read the installed authoring guide. Available offline.                           |
| `init`         | Create a local YAML draft.                                                       |
| `show`         | Read a draft or one field.                                                       |
| `set`          | Add or replace one draft field.                                                  |
| `remove`       | Remove one draft field.                                                          |
| `step add`     | Add a complete operation.                                                        |
| `step update`  | Change fields of an existing step.                                               |
| `step remove`  | Remove an operation.                                                             |
| `step move`    | Change display order.                                                            |
| `check set`    | Set the operation's independent check.                                           |
| `check remove` | Remove the operation's check.                                                    |
| `check`        | Edit an operation's check.                                                       |
| `validate`     | Check the definition and local setup without running the work.                   |
| `diff`         | Compare two documents.                                                           |
| `schema`       | Read the machine-readable grammar.                                               |
| `create`       | Save a complete local draft as a new online method.                              |
| `get`          | Read an online method; optionally make a local draft for editing.                |
| `save`         | Save a draft as one online version.                                              |
| `update`       | Save a full method against an explicit base version.                             |
| `status`       | Check installation and sign-in without listing Methods or starting login.        |
| `list`         | Find your online methods.                                                        |
| `steps`        | Read all complete step definitions in a saved method.                            |
| `step`         | Read one online step. For local edits use step add/update/remove/move.           |
| `login`        | Connect this computer with browser approval.                                     |
| `logout`       | Disconnect this computer from the selected Method server.                        |
| `devices`      | List authorized computers.                                                       |
| `revoke`       | Revoke a computer's Method access.                                               |
| `runs`         | Read saved run summaries.                                                        |
| `logs`         | Read saved run evidence before a repair.                                         |
| `sync`         | Retry upload of records from an existing local run.                              |
| `run`          | Execute a saved method locally and upload its run records.                       |
| `migrate`      | Create a current Method version from an older method.                            |

`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:

```sh theme={null}
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](https://github.com/method-ai-hq/method-spec) to test its validator and executor. This is a development harness, not a second installed product CLI.