Installing the CLI
Found this helpful? Share it:
Found this helpful? Share it:
The idapt CLI is the @idapt/cli npm package. It gives you
the idapt <resource> <verb>command, the same
grammar the in-app agent and MCP speak. It needs Node.js 18 or newer and
works on macOS, Linux, and Windows 📦
Install it globally with npm:
npm i -g @idapt/cliThis puts the idapt command on your $PATH.
Other package managers work too:
pnpm add -g @idapt/cli
yarn global add @idapt/cli
bun add -g @idapt/cliFor one-off use you can skip the install: npx @idapt/cli <command>always runs the latest
published version.
Sign in once. It opens your browser (OAuth 2.1 with PKCE):
idapt loginOn a headless machine or over SSH it falls back to a device code you
approve in any browser. For CI, set the IDAPT_API_KEY environment variable (create a key under Settings → Developer), or pipe one in with --api-key-stdin. See CLI authentication for
the full flow and API keys and scopes for creating
keys.
Print the installed version:
idapt versionThen confirm you are signed in with idapt whoami, which
reports the account and workspace you are acting as.
Update to the latest release at any time:
idapt upgradeidapt upgrade detects how you installed it (npm, pnpm,
yarn, bun, or volta) and runs the right update, or prints the exact
command if it cannot. idapt upgrade --check reports
without installing, and idapt upgrade --next tracks the
pre-release channel. The CLI also prints a one-line nudge when a newer
version is available (silenced in CI and non-interactive shells).
Remove the global package with the manager you used to install it:
npm uninstall -g @idapt/cli
pnpm remove -g @idapt/cli
yarn global remove @idapt/cli
bun remove -g @idapt/cliRun idapt logout first to clear the stored credential.
The CLI stores its credential and a small update-check cache under your platform's standard locations:
Linux: config in ~/.config/idapt/,
cache in ~/.cache/idapt/
macOS: config in ~/Library/Application Support/idapt/, cache in ~/Library/Caches/idapt/
Windows: config in %AppData%\idapt\,
cache in %LocalAppData%\idapt\
On Linux these honor $XDG_CONFIG_HOME and $XDG_CACHE_HOME when you have set them.
Features that run on a machine, such as pairing a computer, the Drive
mount, tunnels, and local inference, are handled by a separate binary,
the idapt-computer daemon. The desktop app installs and
manages it for you, and you can also pair a machine from the in-app
"Connect a computer" flow. The @idapt/cli package on this
page is the API client only. See The computer daemon.
Related articles
Was this helpful?