What is the idapt CLI
Found this helpful? Share it:
Found this helpful? Share it:
The idapt CLI brings your whole workspace to the terminal: chats, agents, Drive files, tasks, computers, and every other resource, through the same grammar the in-app agent speaks. It is built for scripts, pipelines, and anyone who would rather type than click 💻
idapt ships two separate binaries, split by whose identity they use. One acts as you; the other acts as the machine it runs on.
@idapt/cli: the idapt command. It
talks to the idapt API and owns the idapt <resource> <verb>grammar, the same
one the in-app agent and MCP use. This is the tool for your
terminal, scripts, and CI.
idapt-computer: the daemon that runs on a machine you pair with idapt. It handles the machine side: the background service, tunnels, and the local model runtime. It signs in as the machine, not as you, so it needs no login at all. See The computer daemon.
Every command reads as idapt <resource> <verb> [flags], for example idapt chat list or idapt drive read. The
command set is generated from the same registry that powers the REST
API, so the CLI, the API, and MCP always agree on what exists.
You never have to guess a flag. Two verbs describe the rest:
idapt help <resource> <verb>prints the
contract: the arguments, their types and defaults, the shape it
returns, and the errors it can raise.
idapt instructions <resource>prints the
playbook: when to reach for each verb, and the anti-patterns to
avoid.
--help and --instructions do the same thing
inline on any command.
Start with idapt instructions <resource>when a
resource is new to you, then idapt help on the exact verb
before you run it.
Anything you can do in the browser has a command. The main families are chats and agents, Drive files, tasks, computers, agent memory, automations, notifications, and models and inference. See Command reference for the full list and how to browse it.
Every command exits with a code that says what kind of failure it was, so a script can decide whether retrying would even help:
0 succeeded2 not signed in, or your session expired: sign in again3 signed in but not permitted: retrying will not help4 no such resource5 payment or quota required6 the request was rejected as invalid7 rate limited: wait and retry8 idapt is unavailable: retry laterTurn on tab completion once and every resource and verb completes as you type:
idapt completion installInstall the CLI from npm, sign in once, and run your first command. Installing the CLI has the steps.
Related articles
Installing the CLI
Install, sign in, upgrade, and uninstall the idapt CLI on macOS, Linux, and Windows.
CLI authentication
Sign in from a browser or a headless machine, use API keys in CI, and set the workspace and agent you act as.
Command reference
The idapt <resource> <verb> grammar, how to discover any command from the terminal, and the full command list.
Was this helpful?