Skip to main content

​
Global Options

These options can be used with any command.
OptionDescription
--endpoint <url>Override the API base URL for this invocation
--versionPrint the CLI version
--helpShow help for a command
adapter --endpoint http://localhost:8080 connections

​
adapter login

Authenticate the CLI with your Adapter API key. 
adapter login
The key is stored in your local config file. You can view the config path with adapter config. Options
OptionDefaultDescription
--api-url <url>https://api.adapter.comAPI base URL to authenticate against
adapter login --api-url https://api.staging.adapter.com

​
adapter connectors

List all available connectors (e.g. slack, gmail, google-drive). 
adapter connectors

​
adapter connect <connector>

Connect an account for the given connector via OAuth. Opens a browser window to complete authorization. 
adapter connect slack
adapter connect gmail
The CLI polls for the new connection and confirms once OAuth completes. If the browser doesn’t open automatically, a URL is printed that you can open manually.

​
adapter connections

List all active connections on your account. 
adapter connections
Example output 
PROVIDER    ACCOUNT                        CONNECTION ID                            CONNECTED
────────────────────────────────────────────────────────────────────────────────────────────
slack       My Workspace                   conn_abc123...                           1/15/2025
gmail       user@example.com               conn_def456...                           1/20/2025

​
adapter disconnect <connector>

Remove a connection for the given connector. Prompts for confirmation before deleting. 
adapter disconnect slack
If multiple connections exist for the same provider, each is confirmed individually.

​
adapter config

Show current CLI configuration (API URL, stored credentials). 
adapter config

​
adapter config set [pairs...]

Update one or more config values using key=value pairs. 
adapter config set apiUrl=http://localhost:8080
Settable keys
KeyDescription
apiUrlAPI base URL