Skip to content

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.

CommandWhat it does
atoi workspace showRead the repository and branch a Project is bound to.
atoi workspace bindBind a Project to the repository and branch it builds from.
atoi workspace statusReport the local checkout state for a bound Project.
atoi workspace clearClear one Workspace: its conversation, documents, automations and their runs, tasks, and open questions go; settings, connections, plugins, skills, and memories stay.
atoi workspace changesRead 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>]

FlagTypeDefaultValuesWhat it does
--projectstringSelect a Project by id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run workspace show

bash
atoi workspace show prj_8k2v --json

#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>]

FlagTypeDefaultValuesWhat it does
--projectstringSelect a Project by id.
--repostringAttach a credential-free repository URL or owner/repository shorthand.
--branchstringAttach the authoritative repository branch.
--directorystringUse a local Git directory or a path within the attached repository.
--idempotency-keystringReuse a mutation identity when you safely retry the same action.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run workspace bind

bash
atoi workspace bind prj_8k2v --repo owner/repository --branch main --json

#workspace status

Check and report the Project's local source state.

atoi workspace status <project-id> [--project <project-id>] [--directory <path>] [--preview-url <url>]

FlagTypeDefaultValuesWhat it does
--projectstringSelect a Project by id.
--directorystringcurrent directoryInspect this local Git directory.
--preview-urlstringReport a credential-free HTTP or HTTPS preview URL.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run workspace status

bash
atoi workspace status prj_8k2v --directory . --json

#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

FlagTypeDefaultValuesWhat it does
--confirm requiredbooleanAcknowledge that the Workspace is cleared for good.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run workspace clear

bash
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>]

FlagTypeDefaultValuesWhat it does
--projectstringSelect a Project by id.
--taskstringSelect a Task by id instead of a positional id.
--jsonbooleanfalseEmit the canonical JSON envelope.
--ndjsonbooleanfalseEmit one canonical JSON envelope per line.
--formatstringtexttext, jsonChoose human text or the JSON envelope.
--help -hbooleanShow command help.

#Run workspace changes

bash
atoi workspace changes prj_8k2v --task tsk_3m9q --json

Read Run work from the terminal for the rest of this group, or the CLI reference index for every command.

Was this useful?