Workspace CLI reference

Read, attach, check, and inspect a Project's source.

On this page

Use this page to inspect every public atoi workspace command, its accepted flags, and one runnable example. Return to the CLI reference index to choose another command group.

atoi workspaceUse the compatibility source topic retained for existing scripts.

Command	What it does
`atoi workspace show`	Read the source binding for a Project through the compatibility topic.
`atoi workspace bind`	Bind Project source through the compatibility topic.
`atoi workspace status`	Report local source truth through the compatibility topic.
`atoi workspace changes`	Read a Project change set through the compatibility topic.

#`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 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"
  }
}

Was this useful?

#workspace show

#Run workspace show

#workspace bind

#Run workspace bind

#workspace status

#Run workspace status

#workspace changes

#Run workspace changes