Skip to main content

​
What is the Adapter CLI?

The Adapter CLI (adapter) lets you manage connections, run queries, and configure your account without leaving your terminal. It’s built for developers who want a fast, scriptable interface during development and testing.

​
Installation

npm install -g @adapter/cli
Verify the install: 
adapter --version

​
Authentication

Log in once with your Adapter API key. The CLI stores credentials locally. 
adapter login
You’ll be prompted to paste your API key. Generate one in the Adapter dashboard under Settings → API Keys.
You can override the API endpoint for a single command without changing your config:
adapter --endpoint http://localhost:8080 connections

​
Quick Example

# See which connectors are available
adapter connectors

# Connect your Slack workspace via OAuth
adapter connect slack

# List all active connections
adapter connections

# Remove a connection
adapter disconnect slack

​
Next Steps

Commands Reference

Full reference for every CLI command

API Reference

Use the REST API directly or via the TypeScript SDK