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.
| Command | What it does |
|---|---|
atoi workspace invite | Invite a Member to the selected shared Workspace by email, using the same permissions as web. |
atoi workspace create | Create a Workspace you own; it starts with its own conversation, memory, and Projects. |
atoi workspace update | Rename a Workspace, change its description, or set or clear its mark. |
atoi workspace list | List the Workspaces you belong to, the personal one first. |
atoi workspace leave | Leave 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 use | Stand 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 current | Say which Workspace the terminal is standing in. |
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 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 changes | Read 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>
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--personal | boolean | Step back out to Personal, the same as `atoi workspace use personal`. | ||
--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 use
atoi workspace use wsp_2f7d --json#workspace current
Say which Workspace the terminal is standing in.
atoi workspace current
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--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 current
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>]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--name required | string | Name the Workspace. | ||
--description | string | Describe what the Workspace is for. | ||
--emoji | string | Mark the Workspace with an emoji. | ||
--color | string | vermillion, orange, gold, yellow, green, cyan, blue, indigo, magenta, olive | Mark the Workspace with one of the ten colors, or color an icon. | |
--icon | string | folder, globe, bolt, code, cube, archive, database, terminal, bell, user, creditCard, settings | Mark the Workspace with an icon on a color. | |
--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 create
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]
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--name | string | Rename the Workspace. | ||
--description | string | Change the description; an empty value clears it. | ||
--emoji | string | Mark the Workspace with an emoji. | ||
--color | string | Mark the Workspace with one of the ten colors, or color an icon. | ||
--icon | string | Mark the Workspace with an icon on a color. | ||
--clear-mark | boolean | Return the Workspace to its letter mark. | ||
--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 update
atoi workspace update <workspace-id> --emoji "๐" --json#workspace list
List the Workspaces you belong to, the personal one first.
atoi workspace list
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--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 list
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
| Flag | Type | Default | Values | What it does |
|---|---|---|---|---|
--confirm required | boolean | Only a new direct invitation or a new thread link from a member brings you back. | ||
--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 leave
atoi workspace leave eval-solo --confirm --json#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 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
| 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?