Command reference

Every command follows one shape: idapt <resource> <verb> [flags]. This page shows the grammar, how to discover any command from the terminal, and the full command surface 📖

The grammar

A command names a resource and a verb, then flags. A few flags work everywhere:

-o table|json|jsonl|quiet picks the output format. See Output and input formats.
--json '{...}', --json - (stdin), or --json @file passes structured input without shell escaping.
--workspace-id <id>targets one workspace for a single command. To pin it for a session, use idapt workspace use instead. See CLI authentication.

Discover any command

The reference below lists what exists. To learn how to call one, ask the CLI itself:

idapt help <resource> <verb>returns the contract: arguments, types, defaults, the return shape, and possible errors.
idapt instructions <resource>returns the playbook for a resource: when and why to use each verb.

--help and --instructions are the inline equivalents on any command.

Common examples

List verbs take no arguments, so they are the safest place to start. Reads and writes take an id and structured input:

# Who am I, and where am I acting?
idapt whoami

# List resources
idapt workspace list
idapt agent list
idapt chat list -o table
idapt drive list
idapt tasks list
idapt models list -o table

# Pin the workspace later commands run in
idapt workspace use <workspace-id>

# Read one file by id
idapt drive read <file-id>

# Send a chat message (structured input, no shell escaping)
idapt chat send <chat-id> --content "Summarize the latest report"

# Create an agent from a JSON file
idapt agent create --json @agent.json

Not sure of a flag on any line above? Run idapt help <resource> <verb>for the exact arguments before you send it.

Chats and agents

Send messages, branch runs, and manage agents.

Command	What it does
`idapt chat list`	List chats.
`idapt chat get`	Get a chat by id.
`idapt chat create`	Create a chat.
`idapt chat update`	Update a chat (title, model, …).
`idapt chat delete`	Trash a chat.
`idapt chat archive`	Archive a chat.
`idapt chat unarchive`	Unarchive a chat.
`idapt chat restore`	Restore a trashed chat.
`idapt chat permanent-delete`	Permanently delete a trashed chat (irreversible).
`idapt chat messages`	List a chat's messages.
`idapt chat send`	Send a message and generate a response (long-running).
`idapt chat reprompt`	Regenerate a response as a sibling (long-running).
`idapt chat runs`	List a chat's agent runs.
`idapt chat cost`	Get a chat's total cost.
`idapt chat message-costs`	Get per-message and per-run cost details.
`idapt chat compact`	Compact a chat's conversation history.
`idapt chat stop`	Stop the active run in a chat.
`idapt chat export`	Export a chat transcript.
`idapt chat copy-to-agent`	Copy a chat to another agent.
`idapt chat copy-to-workspace`	Copy a chat into another workspace.
`idapt chat fork-to-workspace`	Fork a chat into another workspace.

Command	What it does
`idapt agent list`	List agents.
`idapt agent get`	Get an agent by id.
`idapt agent create`	Create an agent (name, system_prompt, workspace_id, …).
`idapt agent update`	Update an agent's fields.
`idapt agent delete`	Trash an agent.
`idapt agent archive`	Archive an agent.
`idapt agent unarchive`	Unarchive an agent.
`idapt agent restore`	Restore a trashed agent.
`idapt agent permanent-delete`	Permanently delete a trashed agent (irreversible).
`idapt agent move`	Move an agent to another workspace.
`idapt agent copy-to-workspace`	Copy an agent into another workspace.

Workspaces

List, create, and manage the workspaces and members you can reach.

Command	What it does
`idapt workspace list`	List workspaces.
`idapt workspace get`	Get a workspace by id.
`idapt workspace create`	Create a workspace.
`idapt workspace update`	Update a workspace.
`idapt workspace delete`	Delete a workspace.
`idapt workspace archive`	Archive a workspace.
`idapt workspace unarchive`	Unarchive a workspace.
`idapt workspace members`	List workspace members.
`idapt workspace add-member`	Add a workspace member.
`idapt workspace update-member`	Update a member's role/permissions.
`idapt workspace remove-member`	Remove a workspace member.
`idapt workspace invitations`	List workspace invitations.
`idapt workspace invite`	Invite someone to a workspace.
`idapt workspace revoke-invitation`	Revoke a pending workspace invitation.

Drive files

Upload, read, search, and version files.

Command	What it does
`idapt drive list`	List files (cursor-paginated). Filter to a folder with parent_id.
`idapt drive read`	Read a file's raw content (streamed) by id.
`idapt drive get-metadata`	Get a file's metadata by id.
`idapt drive upload`	Upload a file (multipart). Provide workspace_id or parent_id.
`idapt drive update`	Update file name/content. OCC via expected_updated_at.
`idapt drive delete`	Trash a file by id (recoverable with `drive restore`).
`idapt drive restore`	Restore a trashed file.
`idapt drive permanent-delete`	Permanently delete a trashed file (irreversible).
`idapt drive create-folder`	Create-or-get a folder (idempotent).
`idapt drive move`	Move a file to a new parent_id (null = workspace root).
`idapt drive content-versions`	List a file's content version history (newest first).
`idapt drive restore-version`	Restore a file to a previous content version.
`idapt drive glob`	Find files by glob pattern (e.g. */.ts) across the drive.
`idapt drive grep`	Search file contents by regex (modes: content/files/count, ripgrep-style context).

Tasks and automations

Track work, and run agents on a schedule or from a webhook.

Command	What it does
`idapt tasks list-list`	List the Tasks Lists in a workspace.
`idapt tasks list-create`	Create a Tasks List (with a Linear-style key prefix).
`idapt tasks list-get`	Get a Tasks List by id or key.
`idapt tasks list-update`	Update a Tasks List's name, key, description, icon, or access.
`idapt tasks list-delete`	Delete a Tasks List (soft-trash; tasks retained).
`idapt tasks label-list`	List a list's labels.
`idapt tasks label-create`	Create a label in a list.
`idapt tasks label-update`	Update a label's name or color.
`idapt tasks label-delete`	Delete a label.
`idapt tasks list`	List/search a list's tasks (filter by status, priority, assignee).
`idapt tasks search`	List MY tasks across every list in a workspace (assigned to / created by me).
`idapt tasks create`	Create a task in a list.
`idapt tasks import`	Import tasks into a list from a Linear CSV export (status/priority map 1:1; re-imports dedupe by Linear id).
`idapt tasks get`	Get a task by its identifier (OR-123) or resourceId.
`idapt tasks update`	Update a task's fields (title, status, priority, dates, parent).
`idapt tasks delete`	Delete a task (and its sub-tasks).
`idapt tasks task-batch-update`	Bulk-update tasks in a list (status/priority/due date; add or remove labels/assignees).
`idapt tasks task-batch-delete`	Bulk-delete tasks in a list (and their sub-tasks).
`idapt tasks assign`	Assign a task to a workspace member (or unassign).
`idapt tasks unassign`	Remove a single assignee from a task.
`idapt tasks duplicate`	Mark a task as a duplicate of another (or clear the link).
`idapt tasks ancestors`	Get a task's ancestor chain (breadcrumb), root last.
`idapt tasks comment-list`	List a task's comments.
`idapt tasks comment`	Add a comment to a task.
`idapt tasks comment-update`	Edit a comment.
`idapt tasks comment-delete`	Delete a comment.
`idapt tasks events`	List a task's audit events (the timeline, with comments merged client-side).
`idapt tasks dependencies`	Get a task's blocked-by + blocking dependencies.
`idapt tasks depend`	Add a blocked-by dependency (rejected if it would create a cycle).
`idapt tasks undepend`	Remove a blocked-by dependency.

Command	What it does
`idapt automation list`	List automations.
`idapt automation cost-stats-all`	Get automation cost stats keyed by automation id.
`idapt automation get`	Get an automation by id.
`idapt automation create`	Create an automation (cron / webhook).
`idapt automation update`	Update an automation.
`idapt automation delete`	Delete an automation.
`idapt automation archive`	Archive an automation.
`idapt automation unarchive`	Unarchive an automation.
`idapt automation fire`	Fire a webhook automation using its bearer token.
`idapt automation test-fire`	Test-fire an automation now.
`idapt automation cost-stats`	Get one automation's cost stats.
`idapt automation runs`	List an automation's runs.
`idapt automation runs-all`	List automation runs in a workspace.
`idapt automation cancel-run`	Cancel a queued or cancellable automation run.
`idapt automation retry-run`	Admit a new attempt for a retryable terminal run.
`idapt automation rotate-secret`	Rotate a webhook automation's secret.

Computers

Run commands on a machine, move files, and manage exposure.

Command	What it does
`idapt computer list`	List machines you can reach - yours and your orgs' (`--owner me` for just yours, `--workspace-id` for one workspace's reachable set).
`idapt computer get`	Get a computer by id.
`idapt computer create`	Reserved - direct computer creation is not supported (405).
`idapt computer ephemeral`	Provision a self-destroying ephemeral cloud computer.
`idapt computer run`	Run a one-shot command on a fresh (or reused) ephemeral computer.
`idapt computer update`	Update a computer (name, …).
`idapt computer delete`	Delete a computer.
`idapt computer add-exposure`	Expose a machine into a workspace with a capability grant.
`idapt computer update-exposure`	Replace a workspace exposure's capability grant.
`idapt computer remove-exposure`	Stop exposing a machine into a workspace.
`idapt computer transfer`	Transfer a machine to a new owner.
`idapt computer local-inference`	Control a computer's local inference engine and models.
`idapt computer local-models`	List a computer's installed local-inference models.
`idapt computer add-local-model`	Install a local-inference model on a computer.
`idapt computer remove-local-model`	Remove a local-inference model from a computer.
`idapt computer local-inference-map`	Map (or unmap) an installed local model to an Idapt model id.
`idapt computer local-inference-operations`	List a computer's local-inference operations (installs, pulls, …).
`idapt computer local-inference-cancel`	Cancel an in-flight local-inference operation.
`idapt computer start`	Start a computer.
`idapt computer stop`	Stop a computer.
`idapt computer hibernate`	Hibernate a computer.
`idapt computer archive`	Archive a computer.
`idapt computer unarchive`	Unarchive a computer.
`idapt computer rotate-credential`	Rotate a computer's machine credential.
`idapt computer exec`	Run a shell command on a computer (long-running).
`idapt computer terminal`	Manage persistent terminals on a computer.
`idapt computer download`	Download a file from a computer (?path=).
`idapt computer upload`	Upload to a computer - raw `file` bytes OR a Drive `drive_source`.
`idapt computer download-to-drive`	Download a computer path INTO Drive (server-side).
`idapt computer fs`	FS op (list/stat/mkdir/remove).
`idapt computer ports`	List a computer's ports.
`idapt computer port-label`	Label a port.
`idapt computer users`	List computer users.
`idapt computer create-user`	Create a computer user.
`idapt computer get-user`	Get a computer user.
`idapt computer update-user`	Update a computer user.
`idapt computer delete-user`	Delete a computer user.
`idapt computer activity`	Recent activity / event log for a cloud computer.
`idapt computer manage`	Lifecycle a cloud computer: start / hibernate / terminate.
`idapt computer port-open`	Forward a local port via an idapt-authenticated tunnel.
`idapt computer port-close`	Close a forwarded port.
`idapt computer port-make-public`	Make a forwarded port PUBLIC (unauthenticated). Subscriber-only + human-approved + time-boxed.
`idapt computer port-revoke-public`	Revoke a port's public grant - it reverts to authenticated access.

Memory and credentials

Read and write an agent's memory, and manage workspace credentials.

Command	What it does
`idapt memory box-list`	List the agent memories you can access in a workspace.
`idapt memory box-get`	Get a memory box by id.
`idapt memory box-update`	Update a memory box's name, description, or icon.
`idapt memory box-delete`	Clear an agent's memory (soft-delete the box).
`idapt memory list`	List a memory's notes.
`idapt memory read`	Recall a single memory note by its exact title.
`idapt memory write`	Remember: create or update (by title) a memory note. 413 over quota.
`idapt memory delete`	Forget a memory note by its exact title (the Index cannot be deleted).
`idapt memory search`	Recall by keyword - full-text search over a memory's notes.
`idapt memory index-read`	Read the memory's always-injected Index note.
`idapt memory index-write`	Overwrite the memory's Index (the high-level map). 413 over quota.

Command	What it does
`idapt credential list`	List a workspace's credentials (metadata only).
`idapt credential get`	Get a credential's metadata by id (no value).
`idapt credential create`	Store a credential.
`idapt credential update`	Update a credential; a value ROTATES it.
`idapt credential delete`	Soft-delete a credential (recoverable for 30 days).
`idapt credential versions`	List a static credential's version history (metadata only).

Models and inference

Browse models and run one-shot text, image, speech, and transcription calls.

Command	What it does
`idapt models list`	List available LLM models (id, pricing, capabilities).
`idapt models search`	Search LLM models by capability (vision/reasoning), price, capability index, context - filtered + sorted + paginated. Envelope: {items,total_count,offset,has_more,query,applied_filters}.

Command	What it does
`idapt inference text`	Run a one-shot LLM completion (message-based). Returns the completion inline, or an operation handle with `background: true`.
`idapt inference image`	Generate an image from a prompt. Returns the saved image inline, or a handle with `background: true`.
`idapt inference video`	Generate a video as a durable operation (external clients may await it; foreground chat resumes automatically).
`idapt inference speech`	Synthesize speech from text (TTS). Returns the saved audio inline, or a handle with `background: true`.
`idapt inference transcribe`	Transcribe audio to text (STT). Returns the transcript inline, or a handle with `background: true`.

Search and notifications

Search across your resources, and send or read notifications.

Command	What it does
`idapt search query`	Hybrid semantic + keyword search across your files, chats, messages, agents, computers, repos, notes and tasks.

Command	What it does
`idapt notification list`	List notifications.
`idapt notification preferences`	Get notification preferences.
`idapt notification update-preferences`	Bulk update notification preferences.
`idapt notification config`	Get notification config (toasts, sound, quiet hours).
`idapt notification update-config`	Update notification config.
`idapt notification get`	Get a notification.
`idapt notification send`	Send a notification.
`idapt notification update`	Update a notification (mark read, …).
`idapt notification delete`	Delete a notification.
`idapt notification read-all`	Mark all notifications read.

Output and input formats

Control CLI output (table, JSON, JSONL, quiet) and pass input (flags, JSON, a file, or stdin).

CLI authentication

Automation and scripting

Use the idapt CLI in shell scripts, CI/CD pipelines, and unattended automations.

Up next

Output and input formats

Control CLI output (table, JSON, JSONL, quiet) and pass input (flags, JSON, a file, or stdin).

Was this helpful?

Every command follows one shape: idapt <resource> <verb> [flags]. This page shows the grammar, how to discover any command from the terminal, and the full command surface 📖

The grammar

A command names a resource and a verb, then flags. A few flags work everywhere:

-o table|json|jsonl|quiet picks the output format. See Output and input formats.
--json '{...}', --json - (stdin), or --json @file passes structured input without shell escaping.
--workspace-id <id>targets one workspace for a single command. To pin it for a session, use idapt workspace use instead. See CLI authentication.

Discover any command

The reference below lists what exists. To learn how to call one, ask the CLI itself:

idapt help <resource> <verb>returns the contract: arguments, types, defaults, the return shape, and possible errors.
idapt instructions <resource>returns the playbook for a resource: when and why to use each verb.

--help and --instructions are the inline equivalents on any command.

Common examples

List verbs take no arguments, so they are the safest place to start. Reads and writes take an id and structured input:

# Who am I, and where am I acting?
idapt whoami

# List resources
idapt workspace list
idapt agent list
idapt chat list -o table
idapt drive list
idapt tasks list
idapt models list -o table

# Pin the workspace later commands run in
idapt workspace use <workspace-id>

# Read one file by id
idapt drive read <file-id>

# Send a chat message (structured input, no shell escaping)
idapt chat send <chat-id> --content "Summarize the latest report"

# Create an agent from a JSON file
idapt agent create --json @agent.json

Not sure of a flag on any line above? Run idapt help <resource> <verb>for the exact arguments before you send it.

Chats and agents

Send messages, branch runs, and manage agents.

Command	What it does
`idapt chat list`	List chats.
`idapt chat get`	Get a chat by id.
`idapt chat create`	Create a chat.
`idapt chat update`	Update a chat (title, model, …).
`idapt chat delete`	Trash a chat.
`idapt chat archive`	Archive a chat.
`idapt chat unarchive`	Unarchive a chat.
`idapt chat restore`	Restore a trashed chat.
`idapt chat permanent-delete`	Permanently delete a trashed chat (irreversible).
`idapt chat messages`	List a chat's messages.
`idapt chat send`	Send a message and generate a response (long-running).
`idapt chat reprompt`	Regenerate a response as a sibling (long-running).
`idapt chat runs`	List a chat's agent runs.
`idapt chat cost`	Get a chat's total cost.
`idapt chat message-costs`	Get per-message and per-run cost details.
`idapt chat compact`	Compact a chat's conversation history.
`idapt chat stop`	Stop the active run in a chat.
`idapt chat export`	Export a chat transcript.
`idapt chat copy-to-agent`	Copy a chat to another agent.
`idapt chat copy-to-workspace`	Copy a chat into another workspace.
`idapt chat fork-to-workspace`	Fork a chat into another workspace.

Command	What it does
`idapt agent list`	List agents.
`idapt agent get`	Get an agent by id.
`idapt agent create`	Create an agent (name, system_prompt, workspace_id, …).
`idapt agent update`	Update an agent's fields.
`idapt agent delete`	Trash an agent.
`idapt agent archive`	Archive an agent.
`idapt agent unarchive`	Unarchive an agent.
`idapt agent restore`	Restore a trashed agent.
`idapt agent permanent-delete`	Permanently delete a trashed agent (irreversible).
`idapt agent move`	Move an agent to another workspace.
`idapt agent copy-to-workspace`	Copy an agent into another workspace.

Workspaces

List, create, and manage the workspaces and members you can reach.

Command	What it does
`idapt workspace list`	List workspaces.
`idapt workspace get`	Get a workspace by id.
`idapt workspace create`	Create a workspace.
`idapt workspace update`	Update a workspace.
`idapt workspace delete`	Delete a workspace.
`idapt workspace archive`	Archive a workspace.
`idapt workspace unarchive`	Unarchive a workspace.
`idapt workspace members`	List workspace members.
`idapt workspace add-member`	Add a workspace member.
`idapt workspace update-member`	Update a member's role/permissions.
`idapt workspace remove-member`	Remove a workspace member.
`idapt workspace invitations`	List workspace invitations.
`idapt workspace invite`	Invite someone to a workspace.
`idapt workspace revoke-invitation`	Revoke a pending workspace invitation.

Drive files

Upload, read, search, and version files.

Command	What it does
`idapt drive list`	List files (cursor-paginated). Filter to a folder with parent_id.
`idapt drive read`	Read a file's raw content (streamed) by id.
`idapt drive get-metadata`	Get a file's metadata by id.
`idapt drive upload`	Upload a file (multipart). Provide workspace_id or parent_id.
`idapt drive update`	Update file name/content. OCC via expected_updated_at.
`idapt drive delete`	Trash a file by id (recoverable with `drive restore`).
`idapt drive restore`	Restore a trashed file.
`idapt drive permanent-delete`	Permanently delete a trashed file (irreversible).
`idapt drive create-folder`	Create-or-get a folder (idempotent).
`idapt drive move`	Move a file to a new parent_id (null = workspace root).
`idapt drive content-versions`	List a file's content version history (newest first).
`idapt drive restore-version`	Restore a file to a previous content version.
`idapt drive glob`	Find files by glob pattern (e.g. */.ts) across the drive.
`idapt drive grep`	Search file contents by regex (modes: content/files/count, ripgrep-style context).

Tasks and automations

Track work, and run agents on a schedule or from a webhook.

Command	What it does
`idapt tasks list-list`	List the Tasks Lists in a workspace.
`idapt tasks list-create`	Create a Tasks List (with a Linear-style key prefix).
`idapt tasks list-get`	Get a Tasks List by id or key.
`idapt tasks list-update`	Update a Tasks List's name, key, description, icon, or access.
`idapt tasks list-delete`	Delete a Tasks List (soft-trash; tasks retained).
`idapt tasks label-list`	List a list's labels.
`idapt tasks label-create`	Create a label in a list.
`idapt tasks label-update`	Update a label's name or color.
`idapt tasks label-delete`	Delete a label.
`idapt tasks list`	List/search a list's tasks (filter by status, priority, assignee).
`idapt tasks search`	List MY tasks across every list in a workspace (assigned to / created by me).
`idapt tasks create`	Create a task in a list.
`idapt tasks import`	Import tasks into a list from a Linear CSV export (status/priority map 1:1; re-imports dedupe by Linear id).
`idapt tasks get`	Get a task by its identifier (OR-123) or resourceId.
`idapt tasks update`	Update a task's fields (title, status, priority, dates, parent).
`idapt tasks delete`	Delete a task (and its sub-tasks).
`idapt tasks task-batch-update`	Bulk-update tasks in a list (status/priority/due date; add or remove labels/assignees).
`idapt tasks task-batch-delete`	Bulk-delete tasks in a list (and their sub-tasks).
`idapt tasks assign`	Assign a task to a workspace member (or unassign).
`idapt tasks unassign`	Remove a single assignee from a task.
`idapt tasks duplicate`	Mark a task as a duplicate of another (or clear the link).
`idapt tasks ancestors`	Get a task's ancestor chain (breadcrumb), root last.
`idapt tasks comment-list`	List a task's comments.
`idapt tasks comment`	Add a comment to a task.
`idapt tasks comment-update`	Edit a comment.
`idapt tasks comment-delete`	Delete a comment.
`idapt tasks events`	List a task's audit events (the timeline, with comments merged client-side).
`idapt tasks dependencies`	Get a task's blocked-by + blocking dependencies.
`idapt tasks depend`	Add a blocked-by dependency (rejected if it would create a cycle).
`idapt tasks undepend`	Remove a blocked-by dependency.

Command	What it does
`idapt automation list`	List automations.
`idapt automation cost-stats-all`	Get automation cost stats keyed by automation id.
`idapt automation get`	Get an automation by id.
`idapt automation create`	Create an automation (cron / webhook).
`idapt automation update`	Update an automation.
`idapt automation delete`	Delete an automation.
`idapt automation archive`	Archive an automation.
`idapt automation unarchive`	Unarchive an automation.
`idapt automation fire`	Fire a webhook automation using its bearer token.
`idapt automation test-fire`	Test-fire an automation now.
`idapt automation cost-stats`	Get one automation's cost stats.
`idapt automation runs`	List an automation's runs.
`idapt automation runs-all`	List automation runs in a workspace.
`idapt automation cancel-run`	Cancel a queued or cancellable automation run.
`idapt automation retry-run`	Admit a new attempt for a retryable terminal run.
`idapt automation rotate-secret`	Rotate a webhook automation's secret.

Computers

Run commands on a machine, move files, and manage exposure.

Command	What it does
`idapt computer list`	List machines you can reach - yours and your orgs' (`--owner me` for just yours, `--workspace-id` for one workspace's reachable set).
`idapt computer get`	Get a computer by id.
`idapt computer create`	Reserved - direct computer creation is not supported (405).
`idapt computer ephemeral`	Provision a self-destroying ephemeral cloud computer.
`idapt computer run`	Run a one-shot command on a fresh (or reused) ephemeral computer.
`idapt computer update`	Update a computer (name, …).
`idapt computer delete`	Delete a computer.
`idapt computer add-exposure`	Expose a machine into a workspace with a capability grant.
`idapt computer update-exposure`	Replace a workspace exposure's capability grant.
`idapt computer remove-exposure`	Stop exposing a machine into a workspace.
`idapt computer transfer`	Transfer a machine to a new owner.
`idapt computer local-inference`	Control a computer's local inference engine and models.
`idapt computer local-models`	List a computer's installed local-inference models.
`idapt computer add-local-model`	Install a local-inference model on a computer.
`idapt computer remove-local-model`	Remove a local-inference model from a computer.
`idapt computer local-inference-map`	Map (or unmap) an installed local model to an Idapt model id.
`idapt computer local-inference-operations`	List a computer's local-inference operations (installs, pulls, …).
`idapt computer local-inference-cancel`	Cancel an in-flight local-inference operation.
`idapt computer start`	Start a computer.
`idapt computer stop`	Stop a computer.
`idapt computer hibernate`	Hibernate a computer.
`idapt computer archive`	Archive a computer.
`idapt computer unarchive`	Unarchive a computer.
`idapt computer rotate-credential`	Rotate a computer's machine credential.
`idapt computer exec`	Run a shell command on a computer (long-running).
`idapt computer terminal`	Manage persistent terminals on a computer.
`idapt computer download`	Download a file from a computer (?path=).
`idapt computer upload`	Upload to a computer - raw `file` bytes OR a Drive `drive_source`.
`idapt computer download-to-drive`	Download a computer path INTO Drive (server-side).
`idapt computer fs`	FS op (list/stat/mkdir/remove).
`idapt computer ports`	List a computer's ports.
`idapt computer port-label`	Label a port.
`idapt computer users`	List computer users.
`idapt computer create-user`	Create a computer user.
`idapt computer get-user`	Get a computer user.
`idapt computer update-user`	Update a computer user.
`idapt computer delete-user`	Delete a computer user.
`idapt computer activity`	Recent activity / event log for a cloud computer.
`idapt computer manage`	Lifecycle a cloud computer: start / hibernate / terminate.
`idapt computer port-open`	Forward a local port via an idapt-authenticated tunnel.
`idapt computer port-close`	Close a forwarded port.
`idapt computer port-make-public`	Make a forwarded port PUBLIC (unauthenticated). Subscriber-only + human-approved + time-boxed.
`idapt computer port-revoke-public`	Revoke a port's public grant - it reverts to authenticated access.

Memory and credentials

Read and write an agent's memory, and manage workspace credentials.

Command	What it does
`idapt memory box-list`	List the agent memories you can access in a workspace.
`idapt memory box-get`	Get a memory box by id.
`idapt memory box-update`	Update a memory box's name, description, or icon.
`idapt memory box-delete`	Clear an agent's memory (soft-delete the box).
`idapt memory list`	List a memory's notes.
`idapt memory read`	Recall a single memory note by its exact title.
`idapt memory write`	Remember: create or update (by title) a memory note. 413 over quota.
`idapt memory delete`	Forget a memory note by its exact title (the Index cannot be deleted).
`idapt memory search`	Recall by keyword - full-text search over a memory's notes.
`idapt memory index-read`	Read the memory's always-injected Index note.
`idapt memory index-write`	Overwrite the memory's Index (the high-level map). 413 over quota.

Command	What it does
`idapt credential list`	List a workspace's credentials (metadata only).
`idapt credential get`	Get a credential's metadata by id (no value).
`idapt credential create`	Store a credential.
`idapt credential update`	Update a credential; a value ROTATES it.
`idapt credential delete`	Soft-delete a credential (recoverable for 30 days).
`idapt credential versions`	List a static credential's version history (metadata only).

Models and inference

Browse models and run one-shot text, image, speech, and transcription calls.

Command	What it does
`idapt models list`	List available LLM models (id, pricing, capabilities).
`idapt models search`	Search LLM models by capability (vision/reasoning), price, capability index, context - filtered + sorted + paginated. Envelope: {items,total_count,offset,has_more,query,applied_filters}.

Command	What it does
`idapt inference text`	Run a one-shot LLM completion (message-based). Returns the completion inline, or an operation handle with `background: true`.
`idapt inference image`	Generate an image from a prompt. Returns the saved image inline, or a handle with `background: true`.
`idapt inference video`	Generate a video as a durable operation (external clients may await it; foreground chat resumes automatically).
`idapt inference speech`	Synthesize speech from text (TTS). Returns the saved audio inline, or a handle with `background: true`.
`idapt inference transcribe`	Transcribe audio to text (STT). Returns the transcript inline, or a handle with `background: true`.

Search and notifications

Search across your resources, and send or read notifications.

Command	What it does
`idapt search query`	Hybrid semantic + keyword search across your files, chats, messages, agents, computers, repos, notes and tasks.

Command	What it does
`idapt notification list`	List notifications.
`idapt notification preferences`	Get notification preferences.
`idapt notification update-preferences`	Bulk update notification preferences.
`idapt notification config`	Get notification config (toasts, sound, quiet hours).
`idapt notification update-config`	Update notification config.
`idapt notification get`	Get a notification.
`idapt notification send`	Send a notification.
`idapt notification update`	Update a notification (mark read, …).
`idapt notification delete`	Delete a notification.
`idapt notification read-all`	Mark all notifications read.

Output and input formats

Control CLI output (table, JSON, JSONL, quiet) and pass input (flags, JSON, a file, or stdin).

CLI authentication

Automation and scripting

Use the idapt CLI in shell scripts, CI/CD pipelines, and unattended automations.

Up next

Output and input formats

Control CLI output (table, JSON, JSONL, quiet) and pass input (flags, JSON, a file, or stdin).

Was this helpful?