Skip to content

Workspace CLI reference


Create, list, and leave the Workspaces you belong to, and read, attach, check, and inspect a Project's source.

Use this page to inspect every public atoi workspace command, its accepted flags, and one runnable example. Two meanings share the word. use, current, create, list, leave, and clear manage Workspaces, the account boundary you and your collaborators share. show, bind, status, and changes keep the CLI's older meaning, a Project's source.

atoi workspaceCreate, list and leave your Workspaces; the Project source verbs stay for existing scripts.

CommandWhat it does
atoi workspace inviteInvite a Member to the selected shared Workspace by email, using the same permissions as web.
atoi workspace createCreate a Workspace you own; it starts with its own conversation, memory, and Projects.
atoi workspace updateRename a Workspace, change its description, or set or clear its mark.
atoi workspace listList the Workspaces you belong to, the personal one first.
atoi workspace leaveLeave a Workspace you are a member of. You lose access to its threads and projects. What you wrote stays. Only a new direct invitation or a new thread link from a member brings you back. The Owner transfers ownership first, and Personal is never left. A terminal standing in the Workspace it left steps back out to Personal.
atoi workspace useStand the terminal in a Workspace until you say otherwise. Every list and search reads it, the way the web reads the Workspace you are looking at. It is kept in this machineโ€™s own Atoi home, so two terminals can stand in two Workspaces at once.
atoi workspace currentSay which Workspace the terminal is standing in.
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 and the record of every send in it, its 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 use

Choose the saved Workspace for later CLI calls that accept Workspace scope

The choice is shared by every shell using the same ATOI_HOME, which defaults to ~/.atoi

Selecting another Workspace in one shell changes the default in the others

Pass --workspace <id> or --personal to override one call without changing the saved choice

For independent saved choices, use a different ATOI_HOME in each shell and configure each home separately

atoi workspace use personal saves Personal as the default

atoi workspace use <workspace-id|personal>

FlagTypeDefaultValuesWhat it does
--personalbooleanStep back out to Personal, the same as `atoi workspace use personal`.
--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 use

bash
atoi workspace use wsp_2f7d --json

#workspace current

Say which Workspace the terminal is standing in.

atoi workspace current

FlagTypeDefaultValuesWhat it does
--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 current

bash
atoi workspace current --json

#workspace create

Create a Workspace you own. It starts with its own thread and Projects.

atoi workspace create --name <name> [--description <text>] [--emoji <emoji> | --color <color> | --icon <icon> --color <color>] [--idempotency-key <key>]

FlagTypeDefaultValuesWhat it does
--name requiredstringName the Workspace.
--descriptionstringDescribe what the Workspace is for.
--emojistringMark the Workspace with an emoji.
--colorstringvermillion, orange, gold, yellow, green, cyan, blue, indigo, magenta, oliveMark the Workspace with one of the ten colors, or color an icon.
--iconstringfolder, globe, bolt, code, cube, archive, database, terminal, bell, user, creditCard, settingsMark the Workspace with an icon on a color.
--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 create

bash
atoi workspace create --name "Eval solo" --json

#workspace update

Rename a Workspace, change its description, or set or clear its mark: an emoji, one of the ten colors, or an icon on a color.

atoi workspace update <workspace-id> [--name <name>] [--description <text>] [--emoji <emoji> | --color <color> | --icon <icon> --color <color> | --clear-mark]

FlagTypeDefaultValuesWhat it does
--namestringRename the Workspace.
--descriptionstringChange the description; an empty value clears it.
--emojistringMark the Workspace with an emoji.
--colorstringMark the Workspace with one of the ten colors, or color an icon.
--iconstringMark the Workspace with an icon on a color.
--clear-markbooleanReturn the Workspace to its letter mark.
--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 update

bash
atoi workspace update <workspace-id> --emoji "๐ŸŒ" --json

#workspace list

List the Workspaces you belong to, the personal one first.

atoi workspace list

FlagTypeDefaultValuesWhat it does
--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 list

bash
atoi workspace list --json

#workspace leave

Leave a Workspace you are a member of, by its id or its slug. You lose access to its threads and projects. What you wrote stays. Only a new direct invitation or a new thread link from a member brings you back.

The Owner transfers ownership first, from the Workspace's Members settings. Personal is never left. If the terminal was standing in the Workspace you left, it steps back out to Personal.

atoi workspace leave <workspace-id|slug> --confirm

FlagTypeDefaultValuesWhat it does
--confirm requiredbooleanOnly a new direct invitation or a new thread link from a member brings you back.
--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 leave

bash
atoi workspace leave eval-solo --confirm --json

#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 thread, documents, automations, 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?