CLI Reference

The StackOne CLI (@stackone/cli) provides commands for building, validating, testing, and deploying custom connectors.

Full Documentation

Complete CLI documentation on npm

Installation

npm install -g @stackone/cli

Command Reference

Agent Commands

Configure the StackOne MCP server for AI coding assistants like Claude, Cursor, and Windsurf.

Command	Description
`stackone agent setup --global`	Configure MCP tools globally in `~/.stackone`
`stackone agent setup --local`	Configure MCP tools for current project only
`stackone agent cleanup`	Remove stored credentials and configuration

# Global setup - configures MCP server for all projects (recommended)
stackone agent setup --global

# Project-scoped setup - configures MCP server for current directory
stackone agent setup --local

# Remove all API keys and credentials
stackone agent cleanup

Use --global setup when you want the StackOne MCP tools available across all your projects. Use --local for project-specific configurations.

Connector Development

Command	Description
`stackone validate <path>`	Validate connector YAML syntax and structure
`stackone run`	Execute a connector action locally for testing

# Validate with watch mode
stackone validate ./my-connector/ --watch

# Run an action with local credentials
stackone run \
  --connector my-connector.connector.s1.yaml \
  --account account.json \
  --credentials credentials.json \
  --action-id list_employees \
  --debug

# Run with parameters
stackone run \
  --connector my-connector.connector.s1.yaml \
  --account account.json \
  --credentials credentials.json \
  --action-id get_employee \
  --params params.json

# Run custom action code (for testing action definitions)
stackone run \
  --connector my-connector.connector.s1.yaml \
  --account-id acme-corp-provider \
  --action ./custom-action.yaml

# Save output to file
stackone run \
  --connector my-connector.connector.s1.yaml \
  --account-id acme-corp-provider \
  --action-id list_employees \
  --output-file results.json

Test file formats:

{
  "environment": "production",
  "provider": "provider"
}

{
  "apiKey": "your_api_key"
}

{
  "accessToken": "token",
  "refreshToken": "refresh_token",
  "clientId": "client_id",
  "clientSecret": "client_secret"
}

{
  "employee_id": "12345"
}

Faster iteration: Once your connector is pushed or an account is already linked, skip the credentials file and use --account-id instead:

stackone run \
  --connector my-connector.connector.s1.yaml \
  --account-id acme-corp-provider \
  --action-id list_employees

This uses stored credentials from the linked account, making it easier to iterate on action logic without managing local credential files.Note: Using --account-id requires an API key with connectors:read scope.

Deployment

Deployment commands require an API key with Connectors scopes. See API Keys to generate one.

Command	Description	Required Scope
`stackone push <path>`	Upload connector to StackOne registry	`connectors:write`
`stackone pull`	Download connector files to local filesystem	`connectors:read`
`stackone drop <provider@version>`	Delete a connector version from registry	`connectors:write`
`stackone get`	Retrieve connector configuration (YAML or JSON output)	`connectors:read`

# Push using saved profile
stackone push ./my-connector/ --profile prod

# Push with API key directly
stackone push ./my-connector/ --api-key v1.eu1.xxxxx

# Pull connector files to local directory
stackone pull --connector my_provider --output ./connectors/

# Pull specific version
stackone pull --connector my_provider@1.0.0 --output ./connectors/

# Get connector config as YAML (default)
stackone get --connector my_provider

# Get connector config from a linked account
stackone get --account-id acme-corp-provider --format json --output-file config.json

Configuration

Command	Description
`stackone init`	Configure authentication profiles interactively
`stackone version`	Show version with update check
`stackone update`	Update CLI to latest version

# Interactive setup (prompts for profile name and API key)
stackone init

# Setup for different environments
stackone init --env staging
stackone init --env production

# Check version and available updates
stackone version

# Update to latest version
stackone update

Environment Variables

Variable	Description
`STACKONE_AGENT_MCP_TOKEN`	MCP server access token (set by `agent setup`)

API keys are passed via --api-key flag or stored in your profile configuration, not as environment variables.

Quickstart

Connect Tools

Dashboard

Build Connectors

Full Documentation

Installation

Command Reference

Agent Commands

Connector Development

Deployment

Configuration

Environment Variables

Next Steps

Build Connectors

CI/CD Setup

Full Documentation

​Installation

​Command Reference

​Agent Commands

​Connector Development

​Deployment

​Configuration

​Environment Variables

​Next Steps

Build Connectors

CI/CD Setup

Installation

Command Reference

Agent Commands

Connector Development

Deployment

Configuration

Environment Variables

Next Steps