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.

Prerequisites

bash

npm install -g @cargo-ai/cli
cargo-ai login --oauth                                  # browser sign-in (recommended)
# or: cargo-ai login --token <your-api-token>           # workspace-scoped API token (non-interactive)
# Pin a default workspace at login (with --oauth)
cargo-ai login --oauth --workspace-uuid <uuid>

Verify with

cargo-ai whoami

. All commands output JSON to stdout. Without a global install, prefix every command with

npx @cargo-ai/cli

instead of

cargo-ai

Failed commands exit non-zero and return

{"errorMessage": "..."}

Note: Most workspace management commands require a token with admin access.

Discover resources first

bash

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

bash

cargo-ai whoami
cargo-ai workspaceManagement user list
cargo-ai workspaceManagement user create --user-email <email> --role-slug <slug>
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>

Current user and workspace

bash

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

Users

bash

# List all workspace members
cargo-ai workspaceManagement user list

# Invite a new user (requires their email and a role)
cargo-ai workspaceManagement user create \
  --user-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>

Roles

Roles define what users can do in the workspace.

bash

# List available roles
cargo-ai workspaceManagement role list

Always check available roles before inviting users — use the

slug

from

role list

when creating or updating users.

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.

bash

# List all API tokens (includes name and permissions of each token)
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, it won't be shown again

# 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 only shown once at creation. Store them in a secrets manager (e.g. GitHub Secrets, AWS Secrets Manager).

Folders

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

bash

# List all folders
cargo-ai workspaceManagement folder list

# Create a folder (kind: "tool", "play", "agent", or "file")
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
cargo-ai workspaceManagement folder update --uuid <folder-uuid> --name "Q1 2025 Campaigns"

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

bash

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

bash

# 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 '{\"conjunction\":\"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.

Workspace files

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

bash

# Upload a file
cargo-ai workspaceManagement file upload --file-path <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/tools.md

for the full file upload and batch run workflow.

Help

Every command supports

--help

bash

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

cargo-workspace-management

NPX Install

Tags

SKILL.md Content

Cargo CLI — Workspace

Prerequisites

Discover resources first

Quick reference

Current user and workspace

Users

Roles

API tokens

Folders

Reports

Workspace files

Help