Skip to content

Connect Commands

Commands and global flags for connecting to a provider, agent, or runtime.

Overview

SuperQode provides two ways to connect:

  • --connect / -C global flag -- set the connection profile on startup.
  • superqode connect command group -- interactive connect, setup guides, and agent connections.

--connect / -C Global Flag

Select a connection profile directly from the CLI.

superqode --connect PROFILE [COMMAND]
superqode -C PROFILE [COMMAND]

Choices

Profile Description
codex Self-contained. Uses Codex SDK. Auto-sets runtime to codex-sdk. Requires openai_codex package and ~/.codex/auth.json.
claude Self-contained. Uses Claude Agent SDK. Auto-sets runtime to claude-agent-sdk. Requires claude_agent_sdk package and ANTHROPIC_API_KEY.
antigravity Handoff to the agy CLI for Antigravity cloud-managed sessions.
byok Bring Your Own Key. Connect to a cloud provider with your own API key.
local Connect to a local or self-hosted provider (Ollama, MLX, LM Studio, etc.).
acp Connect to an ACP (Agent Client Protocol) coding agent. Opens an interactive agent picker.

Self-Contained Profiles

codex and claude are self-contained profiles. They each bundle their own runtime, so the runtime setting is automatically selected:

  • --connect codex sets runtime to codex-sdk
  • --connect claude sets runtime to claude-agent-sdk

Examples

# Start the TUI connected to Anthropic
superqode --connect byok anthropic claude-sonnet-4

# Run a headless task via Codex
superqode --connect codex -p "explain this project"

# Run a headless task via Claude Agent SDK
superqode --connect claude -p "refactor this module"

# Connect to a local model
superqode --connect local ollama qwen3:8b

# Connect to an ACP agent
superqode --connect acp opencode

# Handoff to Antigravity
superqode --connect antigravity

Connection Profiles

codex

Uses the Codex SDK as the runtime backend.

Requirement Details
Python package openai_codex
Auth ~/.codex/auth.json (managed by the Codex CLI)
Runtime Auto-set to codex-sdk

claude

Uses the Claude Agent SDK as the runtime backend.

Requirement Details
Python package claude_agent_sdk
Auth ANTHROPIC_API_KEY environment variable
Runtime Auto-set to claude-agent-sdk

antigravity

Hands off session management to the agy CLI. The Antigravity service handles provider selection, sandbox provisioning, and session persistence in the cloud.

byok

Bring Your Own Key. Connect to any supported cloud provider using your own API key. Provider and model arguments are optional; when omitted, interactive pickers open.

local

Connect to a local or self-hosted provider (Ollama, MLX, LM Studio, vLLM, DS4, etc.). Provider and model arguments are optional; interactive pickers open when omitted.

acp

Connect to any ACP-compatible coding agent installed on your system. Opens an interactive agent picker when no agent name is given.

superqode connect

The superqode connect command group provides subcommands for connecting to providers, agents, and runtimes, as well as viewing setup guides.

superqode connect COMMAND [OPTIONS] [ARGS]

Subcommands

Command Description
connect acp Connect to an ACP coding agent
connect byok Connect to a cloud provider
connect local Connect to a local provider
connect setup Show setup guide for a provider

connect acp

Connect to an ACP (Agent Client Protocol) coding agent by short name.

superqode connect acp AGENT [OPTIONS]

Arguments

Argument Description
AGENT Agent short name (e.g., opencode)

Options

Option Description
--project-dir, -d Project directory for the agent session

Examples

# Connect to OpenCode
superqode connect acp opencode

# Connect with a custom project directory
superqode connect acp opencode --project-dir /path/to/project
superqode connect acp opencode -d /path/to/project

Notes

This command launches a simple CLI interactive session. For the full TUI experience, run superqode and use :connect acp <agent> inside the TUI.

connect byok

Connect to a cloud provider using your own API key. Provider and model are optional; missing arguments open interactive pickers.

superqode connect byok [PROVIDER] [MODEL]

Arguments

Argument Description
PROVIDER Provider ID (e.g., anthropic, openai, google). Opens picker if omitted.
MODEL Model ID (e.g., claude-sonnet-4, gpt-4o). Opens picker if omitted.

Examples

# Full inline specification
superqode connect byok anthropic claude-sonnet-4

# Provider only; picker for model
superqode connect byok anthropic

# Both missing; pickers for provider and model
superqode connect byok

connect local

Connect to a local or self-hosted provider. Provider and model are optional; missing arguments open interactive pickers.

superqode connect local [PROVIDER] [MODEL]

Arguments

Argument Description
PROVIDER Local provider ID (e.g., ollama, lmstudio, mlx, ds4). Opens picker if omitted.
MODEL Model ID. Opens picker if omitted.

Examples

# Full inline specification
superqode connect local ollama qwen3:8b

# Provider only; picker for model
superqode connect local ollama

# Both missing; pickers for provider and model
superqode connect local

connect setup

Show a setup guide for any of the 130+ supported providers. Displays required environment variables, base URL, documentation URL, example models, and the exact connect command.

superqode connect setup PROVIDER [OPTIONS]

Arguments

Argument Description
PROVIDER Provider ID (e.g., anthropic, ollama, deepseek)

Options

Option Description
--json Emit JSON output

Examples

# Show setup guide for Anthropic
superqode connect setup anthropic

# Show setup guide for Ollama
superqode connect setup ollama

# Show setup guide for DeepSeek as JSON
superqode connect setup deepseek --json

Output

Provider: Anthropic
Category: US Labs
Tier: Tier 1

Environment Variables:
  ANTHROPIC_API_KEY (required)

Base URL: https://api.anthropic.com
Documentation: https://docs.anthropic.com/

Example Models:
  - claude-opus-4-5
  - claude-sonnet-4-5
  - claude-haiku-4-5

Connect Command:
  superqode connect byok anthropic <model>
  • superqode providers list - List available providers
  • superqode providers test - Test provider connection
  • superqode agents list - List installed ACP agents
  • superqode auth info - Show authentication status