Skip to main content
The superglue CLI (sg) lets you build, run, and manage integration tools from the terminal. It connects to your superglue instance (cloud or self-hosted) and supports both interactive and scriptable workflows.

​
Installation

npm install -g @superglue/cli
Verify the install: 
sg --version

​
Setup

Run the interactive setup wizard: 
sg init
This prompts for:
  • API key — from your superglue dashboard (Settings → API Keys)
  • API endpoint — defaults to https://api.superglue.cloud
  • Output mode — stdout only, or stdout + file
  • Config location — project-local (.superglue/config.json) or global (~/.superglue/config.json)
Alternatively, set environment variables directly: 
export SUPERGLUE_API_KEY="your-api-key"
export SUPERGLUE_API_ENDPOINT="https://api.superglue.cloud"

​
Configuration Resolution

Both API key and endpoint resolve in this order:
  1. CLI flag (--api-key, --endpoint)
  2. Environment variable (SUPERGLUE_API_KEY, SUPERGLUE_API_ENDPOINT)
  3. Config file
  4. Default (endpoint defaults to https://api.superglue.cloud)

​
Global Flags

These flags work with any command:
FlagDescription
--api-key <key>Override API key
--endpoint <url>Override API endpoint
--jsonForce JSON output (default in non-TTY environments)
-V, --versionPrint CLI version
-h, --helpShow help

​
Command Structure

sg
├── init                     Setup wizard
├── update                   Update CLI
├── tool
│   ├── build                Build a tool from config
│   ├── run                  Execute a tool
│   ├── edit                 Edit via JSON Patch
│   ├── save                 Persist a draft
│   ├── list                 List saved tools
│   └── find                 Search tools
├── system
│   ├── create               Create a system
│   ├── edit                 Edit a system
│   ├── list                 List systems
│   ├── find                 Search systems
│   ├── call                 Make authenticated calls
│   ├── search-docs          Search system docs
│   └── oauth                OAuth authentication
└── run
    ├── list                 List execution runs
    └── get                  Get run details

​
AI Agent Integration

Install as a skill for AI coding agents (35+ agents supported): 
npx skills add superglue-ai/cli
Or target a specific agent: 
npx skills add superglue-ai/cli -g -a cursor
npx skills add superglue-ai/cli -g -a claude-code
npx skills add superglue-ai/cli -g -a codex

​
Next steps

Commands Reference

Full reference for every CLI command and flag