Workspace CLI reference
Read, attach, check, and inspect a Project's source, and clear a Workspace.
Use this page to inspect every public atoi workspace command, its accepted flags, and one runnable example. These commands read and attach a Project's source; the word is the CLI's older name for that source, while a Workspace in the product is the account boundary you share.
atoi workspaceUse the compatibility source topic retained for existing scripts.
| Command | What it does |
|---|---|
atoi workspace show | Read the repository and branch a Project is bound to. |
atoi workspace bind | Bind a Project to the repository and branch it builds from. |
atoi workspace status | Report the local checkout state for a bound Project. |
atoi workspace clear | Clear one Workspace: its conversation, documents, automations and their runs, tasks, and open questions go; settings, connections, plugins, skills, and memories stay. |
atoi workspace changes | Read the pending change set for a bound Project. |
#workspace show
Read the source attached to a Project.
atoi workspace show <project-id> [--project <project-id>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--project | string | Select a Project by id. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run workspace show
atoi workspace show prj_8k2v --json
{
"tool": "atoi_workspace",
"arguments": {
"action": "show",
"project_id": "prj_8k2v"
}
}
#workspace bind
Attach a repository and branch to a Project.
atoi workspace bind <project-id> [--project <project-id>] --repo <owner/repo> --branch <branch> [--directory <path>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--project | string | Select a Project by id. | ||
--repo | string | Attach a credential-free repository URL or owner/repository shorthand. | ||
--branch | string | Attach the authoritative repository branch. | ||
--directory | string | Use a local Git directory or a path within the attached repository. | ||
--idempotency-key | string | Reuse a mutation identity when you safely retry the same action. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run workspace bind
atoi workspace bind prj_8k2v --repo owner/repository --branch main --json
{
"tool": "atoi_workspace",
"arguments": {
"action": "bind",
"project_id": "prj_8k2v",
"repo_url": "https://example.com/river/atlas-notes.git",
"repo_branch": "main",
"idempotency_key": "workspace_atlas_1"
}
}
#workspace status
Check and report the Project's local source state.
atoi workspace status <project-id> [--project <project-id>] [--directory <path>] [--preview-url <url>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--project | string | Select a Project by id. | ||
--directory | string | current directory | Inspect this local Git directory. | |
--preview-url | string | Report a credential-free HTTP or HTTPS preview URL. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run workspace status
atoi workspace status prj_8k2v --directory . --json
{
"tool": "atoi_workspace",
"arguments": {
"action": "status",
"project_id": "prj_8k2v"
}
}
#workspace clear
Empty one Workspace without deleting it. Its conversation, documents, automations and their runs, tasks, and open questions go. Settings, connections, plugins, skills, and memories stay.
A cleared Workspace does not come back. Confirm the id before you pass
--confirm.
atoi workspace clear [<workspace-id>] --confirm
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--confirm required | boolean | Acknowledge that the Workspace is cleared for good. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run workspace clear
atoi workspace clear wsp_3f8a --confirm --json
#workspace changes
Read a Project's latest or selected Task change set.
atoi workspace changes <project-id> [--project <project-id>] [--task <task-id>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--project | string | Select a Project by id. | ||
--task | string | Select a Task by id instead of a positional id. | ||
--json | boolean | false | Emit the canonical JSON envelope. | |
--ndjson | boolean | false | Emit one canonical JSON envelope per line. | |
--format | string | text | text, json | Choose human text or the JSON envelope. |
--help -h | boolean | Show command help. |
#Run workspace changes
atoi workspace changes prj_8k2v --task tsk_3m9q --json
{
"tool": "atoi_workspace",
"arguments": {
"action": "changes",
"project_id": "prj_8k2v",
"task_id": "tsk_7m3q"
}
}
Read Run work from the terminal for the rest of this group, or the CLI reference index for every command.
Was this useful?