Project CLI reference

Create Projects, attach source, inspect state, and manage the Project lifecycle.

On this page

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

atoi projectCreate Projects, attach source, inspect state, and manage the Project lifecycle.

Command	What it does
`atoi project list`	List Projects you can operate.
`atoi project create`	Create a Project and optionally attach its authoritative source.
`atoi project get`	Read one Project and its source attachment.
`atoi project update`	Change one or more editable Project fields.
`atoi project attach`	Attach authoritative repository source to a Project.
`atoi project source`	Read a Project source binding and last reported source state.
`atoi project status`	Inspect local Git truth and report it against the attached Project source.
`atoi project changes`	Read the latest or selected Task change set for a Project.
`atoi project archive`	Archive one exact Project.
`atoi project restore`	Restore an archived Project.

#`project list`

List Projects you can operate.

atoi project list [--archived]

Flag	Type	Default	Values	What it does
`--archived`	`boolean`	`false`		Include archived Projects.
`--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 `project list`

atoi project list --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "list"
  }
}

#`project create`

Create a Project and optionally attach its authoritative source.

atoi project create --name <name> [--kind <chat|code>] [--description <text>] [--instructions <text>] [--profile <safe|workspace-write>] [--repo <owner/repo> --branch <branch>] [--directory <path>]

Flag	Type	Default	Values	What it does
`--name` required	`string`			Set the Project name.
`--kind`	`string`	`code`	`chat`, `code`	Choose a chat or code Project.
`--description`	`string`			Describe the Project.
`--instructions`	`string`			Set the Project instructions.
`--profile`	`string`		`safe`, `workspace-write`	Set the default Task safety profile.
`--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 `project create`

atoi project create --name "Atlas notes" --repo owner/repository --branch main --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "create",
    "name": "Atlas notes",
    "kind": "code",
    "repo_url": "https://example.com/river/atlas-notes.git",
    "repo_branch": "main",
    "idempotency_key": "project_atlas_1"
  }
}

#`project get`

Read one Project and its source attachment.

atoi project get <project-id>

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 `project get`

atoi project get prj_8k2v --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "get",
    "project_id": "prj_8k2v"
  }
}

#`project update`

Change one or more editable Project fields.

atoi project update <project-id> [--name <name>] [--description <text>] [--instructions <text>] [--profile <safe|workspace-write>]

Flag	Type	Default	Values	What it does
`--name`	`string`			Replace the Project name.
`--description`	`string`			Replace the Project description.
`--instructions`	`string`			Replace the Project instructions.
`--profile`	`string`		`safe`, `workspace-write`	Replace the default Task safety profile.
`--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 `project update`

atoi project update prj_8k2v --description "Release evidence workspace" --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "update",
    "project_id": "prj_8k2v",
    "name": "Atlas release",
    "idempotency_key": "project_atlas_2"
  }
}

#`project attach`

Attach authoritative repository source to a Project.

atoi project attach <project-id> (--repo <owner/repo> --branch <branch> | --directory <local-git-directory>)

Flag	Type	Default	Values	What it does
`--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 `project attach`

atoi project attach 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"
  }
}

#`project source`

Read a Project source binding and last reported source state.

atoi project source <project-id>

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 `project source`

atoi project source prj_8k2v --json

{
  "tool": "atoi_workspace",
  "arguments": {
    "action": "show",
    "project_id": "prj_8k2v"
  }
}

#`project status`

Inspect local Git truth and report it against the attached Project source.

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

Flag	Type	Default	Values	What it does
`--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 `project status`

atoi project status prj_8k2v --directory . --json

{
  "tool": "atoi_workspace",
  "arguments": {
    "action": "status",
    "project_id": "prj_8k2v"
  }
}

#`project changes`

Read the latest or selected Task change set for a Project.

atoi project changes <project-id> [--task <task-id>]

Flag	Type	Default	Values	What it does
`--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 `project changes`

atoi project changes prj_8k2v --task tsk_3m9q --json

{
  "tool": "atoi_workspace",
  "arguments": {
    "action": "changes",
    "project_id": "prj_8k2v",
    "task_id": "tsk_7m3q"
  }
}

#`project archive`

Archive one exact Project.

atoi project archive <project-id> --confirm

Flag	Type	Default	Values	What it does
`--confirm` required	`boolean`			Confirm the exact consequential action after you inspect its target.
`--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 `project archive`

atoi project archive prj_8k2v --confirm --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "archive",
    "project_id": "prj_8k2v",
    "confirmation": true,
    "idempotency_key": "project_atlas_3"
  }
}

#`project restore`

Restore an archived Project.

atoi project restore <project-id>

Flag	Type	Default	Values	What it does
`--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 `project restore`

atoi project restore prj_8k2v --json

{
  "tool": "atoi_projects",
  "arguments": {
    "action": "restore",
    "project_id": "prj_8k2v",
    "idempotency_key": "project_atlas_4"
  }
}

Was this useful?

#project list

#Run project list

#project create

#Run project create

#project get

#Run project get

#project update

#Run project update

#project attach

#Run project attach

#project source

#Run project source

#project status

#Run project status

#project changes

#Run project changes

#project archive

#Run project archive

#project restore

#Run project restore