Cargo CLI — Workspace

Workspace administration: managing users, API tokens, folders, roles, workspace-level files, and submitting reports to workspace management.

See references/response-shapes.md for full JSON response structures. See references/troubleshooting.md for common errors and how to fix them. See references/examples/users.md for user invite and management examples. See references/examples/tokens.md for API token creation and rotation examples. See references/examples/folders.md for organizing resources into folders. See references/examples/reports.md for examples of submitting workspace management reports. See references/examples/sessions.md for session tracking — the Cargo installer scaffolds the Claude Code SessionStart + Stop + SessionEnd hooks automatically.

Bootstrap

Already signed in (cargo-ai whoami returns a workspace)? Skip to the next section.

npm install -g @cargo-ai/cli            # no global install? prefix every command with `npx @cargo-ai/cli`
cargo-ai login --email you@company.com  # emailed code, no browser; creates the account on first use
                                        # alternatives: --oauth (browser) · --token <api-token> (CI)
cargo-ai whoami                         # confirm the active workspace before any write

Every command prints JSON to stdout; failures exit non-zero and print {"error": "...", "status": ..., "body": ...} to stderr. Anything that creates a run or a batch is async — pass --wait-until-finished or poll the matching get. Admin-only: user, role, and envVar writes require workspace-management write (admin) access. Any user can create, list, and remove their own tokens; admin access adds service-user tokens. Folder writes check folder write permission, and report create and session upsert need none. When the full skill bundle is installed, ../cargo/references/prerequisites.md adds the CLI version pin, token scopes, and the admin-only surface.

Discover resources first

cargo-ai whoami                        # current user and active workspace
cargo-ai workspaceManagement user list           # all workspace members
cargo-ai workspaceManagement role list           # available roles
cargo-ai workspaceManagement token list          # all API tokens
cargo-ai workspaceManagement folder list         # all folders

Quick reference

cargo-ai whoami
cargo-ai workspaceManagement user list
cargo-ai workspaceManagement user create --email <email> --role-slug <slug>
cargo-ai workspaceManagement role create --name <name> --slug <slug> --permissions '<json>'
cargo-ai workspaceManagement workspaces list
cargo-ai workspaceManagement token list
cargo-ai workspaceManagement token create --name <name>
cargo-ai workspaceManagement token remove <token-uuid>
cargo-ai workspaceManagement folder list
cargo-ai workspaceManagement folder create --name <name> --emoji-slug <slug> --kind <kind>
cargo-ai workspaceManagement report create --title <title> --description <description>
cargo-ai workspaceManagement session upsert --session-id <id> --title <title> --summary <summary> [--finished]
cargo-ai workspaceManagement envVar list
cargo-ai workspaceManagement envVar create --key <KEY> [--value <v>] [--secret]

Current user and workspace

# Get your current user and workspace context
cargo-ai whoami
# → Returns your user UUID, email, and active workspace UUID

# Workspaces this user can reach, and the one selected now
cargo-ai workspaceManagement workspaces list
cargo-ai workspaceManagement workspaces get-current      # honors CARGO_WORKSPACE_UUID

# Create another workspace (it is not selected for you — sign in to it or set CARGO_WORKSPACE_UUID)
cargo-ai workspaceManagement workspaces create --name "Acme GTM"

# Update the selected workspace — pass the literal "null" to clear a nullable field
cargo-ai workspaceManagement workspaces update --name "Acme GTM (prod)"
cargo-ai workspaceManagement workspaces update --allowed-email-domains acme.com,acme.io
cargo-ai workspaceManagement workspaces update --default-role-uuid <role-uuid>   # role new members get

workspaces update also takes --openai-api-key, --logo-base64, --metadata, --syncs and the Chrome-extension agent fields; it is an admin write, and --openai-api-key is a secret — pass it from the environment, not inline.

Users

# List all workspace members
cargo-ai workspaceManagement user list

# Invite a new user (requires their email and a role)
cargo-ai workspaceManagement user create \
  --email user@example.com \
  --role-slug <role-slug>

# Update a user's role
cargo-ai workspaceManagement user update --user-uuid <uuid> --role-slug <new-role-slug>

# Remove a user from the workspace
cargo-ai workspaceManagement user remove --user-uuid <uuid>

# Grant one user access to one resource (a workflow, folder, agent, app, …)
cargo-ai workspaceManagement user upsert-permission \
  --user-uuids <uuid> --action orchestration:workflow:read --resource-uuid <workflow-uuid> --effect allow

# Take a grant back
cargo-ai workspaceManagement user remove-permission --user-uuid <uuid> --resource-uuid <workflow-uuid> --effect allow

Two things to know about upsert-permission:

• --action is a permission action, not read / write. It must be one of the actions listed under Roles — the resource-scoped ones are orchestration:workflow:*|read|write, ai:agent:…, ai:mcpServer:…, hosting:app:…, hosting:worker:…, content:file:… and workspaceManagement:folder:…. (The help's own --action read example was invalid before CLI 1.0.128.)
• --effect deny applies to existing members only, so it takes --user-uuids; with --emails it is refused, because that path invites. Before cargo#6369 (CLI 1.0.128) the API ignored the effect and always wrote an allow — on a workspace still doing so, put the deny in a role (role create|update --permissions). remove-permission honors --effect either way.

--emails invites any address that isn't a member yet, so check user list first.

Per-member monthly credit cap. PUT /v1/workspaceManagement/users/<user-uuid> accepts {"monthlyCreditsLimit": <n> | null}: the credits a member may consume per UTC calendar month across the runs, batches and agent messages they trigger. null removes it. Admins also set it in the web app (Settings → Users → the member's credits limit), user list returns the field, and there is no CLI flag for it. Once the member reaches the cap, their new credit-consuming work is refused until the next month, the same way an empty workspace balance refuses it. The check gates work before it starts and reads spend cached for up to a minute, so a member can land slightly past the cap. It fails open: if the limit or the ledger can't be read, the work runs. Enforcement shipped with cargo#6379, and caps set before then were stored but not enforced. Per-member spend is readable in cargo-billing (usage get-metrics --group-by user_uuid).

Service users

A service user is a non-human identity with its own role — what a hosted worker, a coding agent's sandbox or a connected GitHub repo acts as, so automation never borrows a person's access. It has no inbox and no login; it authenticates only through its own API tokens (its address is su-<uuid>@service-users.getcargo.io, a domain refused for person invites).

The CLI cannot create one — user create takes only --email and --role-slug. Use the web app, a project's defineUser (see ../cargo-project/references/resources.md), or the API (workspace-management write access):

# POST /v1/workspaceManagement/users
{"kind":"service","firstName":"Enrichment","lastName":"Worker","roleSlug":"<role-slug>"}
# → 201 {user}; 404 roleNotFound / workspaceNotFound
# A token for it: POST /v1/workspaceManagement/tokens {"name":"…","userUuid":"<service-user-uuid>"}
#   (403 unless the caller has workspace-management write and the target is kind "service")

firstName / lastName are optional (1–255 chars). The CLI's token create mints only for the caller, so a service user's own token also goes through the API or the web app.

Run-as. A worker (hosting worker update --run-as-user-uuid, defineWorker({ runAs })), an agent's coding repository (repository.runAsUserUuid, defineAgent({ repository: { runAs } })) or a connected repo can run as a service user; Cargo then binds a temporary CARGO_API_TOKEN for it. Two checks guard the assignment:

So you can only hand automation access you already hold, and a service user with a broader role than yours can't be assigned by you.

Roles

Roles define what users can do in the workspace.

# List available roles
cargo-ai workspaceManagement role list

# Create a custom role: a slug, a colour, and a list of permission statements
cargo-ai workspaceManagement role create \
  --name "Run operator" --slug run-operator --color green \
  --description "Starts and reads runs and batches; cannot edit workflows" \
  --permissions '[
    {"effect":"allow","resources":null,"actions":["orchestration:read","orchestration:run:*","orchestration:batch:*","storage:read","segmentation:read"]}
  ]'

# Update or remove a custom role (built-in roles can't be changed)
cargo-ai workspaceManagement role update --uuid <role-uuid> --permissions '[...]'
cargo-ai workspaceManagement role remove <role-uuid>

Always check available roles before inviting users — use the slug from role list when creating or updating users.

Permission statements are {"effect": "allow" | "deny", "resources": [<uuid>, …] | null, "actions": [...]} — resources: null applies the statement workspace-wide. --permissions on role update replaces the whole list. Actions follow <domain>:*|read|write for ai, billing, connection, content, context, domainManagement, hosting, mailboxManagement, observability, orchestration, revenueOrganization, segmentation, storage, systemOfRecordIntegration and workspaceManagement, plus resource-level sub-actions (orchestration:workflow:…, ai:agent:…, hosting:app:…, workspaceManagement:folder:…, …).

Running is separate from editing in orchestration. orchestration:run:*|read|write covers runs and orchestration:batch:*|read|write covers batches; neither includes the other, and neither lets the holder edit a workflow, play or tool (that is orchestration:write / orchestration:workflow:write). orchestration:read / :write / :* still include both. That is how a role can start and watch runs without being able to change what they do.

role create fails with slugAlreadyExists or slugReserved (a built-in slug); role remove fails with roleInUse while any member holds the role or it is the workspace's default role — reassign them first.

API tokens

Each token has a human-readable name and a permissions field. Tokens created via the CLI are issued with permissions: null, which means the token mirrors the permissions of its owning user (the user who ran token create) — so a token's effective access is bounded by what that user can do in the workspace. Fine-grained permission scoping (an explicit allow/deny list) is configured via the API or the Cargo app.

# List your API tokens (includes name, permissions, and the token value of each)
cargo-ai workspaceManagement token list

# Create a new token — --name is required
cargo-ai workspaceManagement token create --name "CI/CD pipeline"
# → Returns the token value — store it securely

# Remove a token
cargo-ai workspaceManagement token remove <token-uuid>

Naming: Pick a --name that makes the token's purpose obvious in token list later (e.g. "GitHub Actions — production", "Local dev — alice", "Zapier integration"). The name is the only way to tell tokens apart in the listing.

Security: Token values are returned at creation and again by token list (your own tokens, plus service-user tokens for admins). Treat both outputs as secrets and store the value in a secrets manager (e.g. GitHub Secrets, AWS Secrets Manager).

Folders

Folders organize resources (plays, tools, agents) in the Cargo app.

# List all folders
cargo-ai workspaceManagement folder list

# Create a folder (kind: tool, play, agent, file, mcpServer, model, app, worker, alert, or mailbox)
cargo-ai workspaceManagement folder create --name "Q1 Campaigns" --emoji-slug "rocket" --kind "play"

# Get a folder
cargo-ai workspaceManagement folder get <folder-uuid>

# Update a folder (rename, move under a parent, or reorder among its siblings)
cargo-ai workspaceManagement folder update --uuid <folder-uuid> --name "Q1 2025 Campaigns"
cargo-ai workspaceManagement folder update --uuid <folder-uuid> --parent-uuid <parent-folder-uuid> --order 0

# Remove a folder
cargo-ai workspaceManagement folder remove <folder-uuid>

Reports

Submit a report to workspace management. Use this whenever the CLI is failing, behaving unexpectedly, lacks a capability you need, or whenever you (user or agent) are struggling to accomplish a task with the CLI. This is the official feedback channel — every report is reviewed by the Cargo team and used to improve the CLI, its skills, and the underlying APIs.

# Submit a report to workspace management
cargo-ai workspaceManagement report create \
  --title "<short summary>" \
  --description "<detailed description, including the command(s) tried and the error(s) seen>"

When to send a report (non-exhaustive):

• A command exits non-zero with an errorMessage you cannot resolve from --help or references/troubleshooting.md.
• The CLI is being misused or the syntax is unclear (e.g. you can't figure out which flag to pass, or the JSON schema for --filter / --nodes / --action is ambiguous).
• A user or AI agent is repeatedly retrying the same command without progress (≥ 2 failed attempts on the same task).
• A documented command does not behave as the skill describes, or a response shape differs from what references/response-shapes.md documents.
• A capability appears to be missing entirely (no command exists for what you need to do).
• An async operation never reaches a terminal status, or returns inconsistent results across runs.

What to put in the report:

• --title: one-line summary of the problem (e.g. "batch create fails with 'playNotCompatible' on tool workflow").
• --description: include the exact command(s) executed (with sensitive values redacted), the JSON errorMessage, what you expected, what you tried, and any relevant UUIDs (run, batch, workflow, model). The more context you provide, the faster it can be triaged.

# Example: report a CLI struggle after multiple failed attempts
cargo-ai workspaceManagement report create \
  --title "segment fetch returns empty results despite matching records in UI" \
  --description "Ran: cargo-ai segmentation segment fetch --model-uuid <uuid> --filter '{\"conjonction\":\"and\",\"groups\":[...]}'. Got 0 records. The same filter shows 1,200 matches in the app UI. Tried both --filter and --segment-uuid; both return empty. Expected: the same records as the UI."

Do not silently give up on a failing CLI task. Send a report. This closes the feedback loop so the CLI and these skills can be improved.

Sessions

Record a Claude Code session in workspace_management.sessions. One row per (workspaceUuid, sessionId). Used by the cargo router's Claude Code SessionStart + Stop + SessionEnd hook recipe — see ../cargo/SKILL.md for when to wire them up.

# Upsert a session. Idempotent on --session-id within the workspace.
cargo-ai workspaceManagement session upsert \
  --session-id <claude-session-id> \
  --title "<short title>" \
  --summary "<one-or-two sentence summary>"

# Same call, but also stamp finished_at = now
cargo-ai workspaceManagement session upsert \
  --session-id <claude-session-id> \
  --title "<final title>" \
  --summary "<final summary>" \
  --finished

• --session-id, --title, --summary are required on every call. title and summary are NOT NULL in the schema — pass placeholders on the start call and overwrite on the end call.
• --finished stamps finished_at = now. Use --finished-at <iso> for an explicit timestamp instead.
• Calling upsert twice with the same --session-id updates the same row — title and summary are overwritten; finished_at only when --finished or --finished-at is passed.

Returns the upserted session as JSON. The Cargo installer wires SessionStart + Stop + SessionEnd hooks that call this command automatically: SessionStart writes a placeholder, the per-turn Stop hook checkpoints the row (no --finished), and SessionEnd writes the transcript-driven AI summary with --finished — see references/examples/sessions.md.

Environment variables

Workspace environment variables are injected into every worker, app and agent in the workspace, and a worker- or app-level entry with the same key overrides them. One catalog, but when it is read depends on the consumer:

• Agents, and a project's workspaceEnv("NAME") pointers, read the value server-side on each use, so rotating it takes effect with no redeploy.
• Hosted workers and apps capture values at deploy time. A worker's bindings are attached when a deployment is promoted, and non-secret values are compiled into its bundle. An app receives only non-secret entries with a public prefix (VITE_, NEXT_PUBLIC_, …), baked into its build. After a change, run hosting deployment create + promote again. See ../cargo-hosting/SKILL.md → Worker env vars and secrets.

cargo-ai workspaceManagement envVar list

# Create. Omit --value to read it from the environment variable of the same name.
cargo-ai workspaceManagement envVar create \
  --key OPENAI_API_KEY \
  --value sk-... \
  --secret \
  --description "Used by the enrichment worker"

# Update. Omit --value to keep the stored one.
cargo-ai workspaceManagement envVar update <uuid> --value <new> --description <text>

cargo-ai workspaceManagement envVar remove <uuid>

• --secret encrypts the value at rest and it is never returned again — list and update will not echo it back. Use it for credentials; use --no-secret on update to turn a variable back into plain text (which re-exposes it to list).
• --value is optional on create. Omitted, the CLI reads the environment variable of the same name from your shell, so export OPENAI_API_KEY=… && cargo-ai workspaceManagement envVar create --key OPENAI_API_KEY --secret keeps the value out of your shell history and out of this command line.
• update takes the uuid, not the key. Get it from envVar list.

From a project, reference an entry with workspaceEnv("NAME") rather than copying the value into code — it is a pointer resolved server-side on every use. secret("NAME") is the other option and means something different (read from your environment at deploy time). See ../cargo-project/SKILL.md → Critical rules.

Workspace files

Workspace files are CSVs or other data files uploaded for use in batch runs.

# Upload a file
cargo-ai workspaceManagement file upload --file <path-to-file>
# → Returns s3Filename

# Inspect a file's columns before running a batch
cargo-ai workspaceManagement file list-columns --s3-filename <s3-filename>
# → Returns column names to use when mapping to workflow inputs

The s3-filename is returned when uploading a file via cargo-ai workspaceManagement file upload. See the cargo-orchestration skill's references/examples/tools.md for the full file upload and batch run workflow.

Help

Every command supports --help:

cargo-ai workspaceManagement user create --help
cargo-ai workspaceManagement token create --help
cargo-ai workspaceManagement folder create --help