Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@amethyst-labs/quickcli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

QuickCLI (`quick`)

Switch AI coding assistant providers — Claude Code, OpenAI Codex, and OpenCode — with a single command.

Documentation

Guide	Description
Installation	npm, pre-built binaries, build from source
Commands	Full CLI command reference
Configuration	Config file schema and what QuickCLI writes
Templates	Template registry and magic syntax
TemplateFiles	Shipping extra Codex config with a template
Login	ChatGPT OAuth browser & device-code flows
Contributing	Add templates or contribute code

Installation

npm install -g @amethyst-labs/quickcli

Or download a packed npm package from GitHub Releases.

Quick Start

# Interactive TUI menu (bare invocation)
quick

# Add a config (interactive TUI wizard)
quick config add

# Add a config with flags
quick config add privnode \
  --scope codex,claudecode \
  --base-url https://privnode.com/v1 \
  --api-key sk-xxx \
  --model gpt-5-codex

# Add a config from a template
quick config add --from-template openai

# Log in with ChatGPT (creates a Codex config automatically)
quick config login
quick config login --device   # SSH / headless environments

# List configs
quick config list

# Activate a config
quick use privnode

# Check current status
quick status

Commands

Command	Description
`quick`	Open interactive TUI main menu
`quick config add [name] [flags]`	Add a config (TUI wizard or flags)
`quick config list`	List all configs
`quick config remove <name>`	Remove a config
`quick config login [name]`	Log in with ChatGPT and create a Codex config
`quick template list`	List registry templates
`quick template preview <id>`	Preview a template
`quick use <config-name>`	Activate a config
`quick status`	Show active configuration

How It Works

quick writes configuration to:

Tool	Files
Claude Code	`~/.claude/settings.json` (`env` key) + shell profile
Codex	`~/.codex/config.toml` + `~/.codex/auth.json` + shell profile
OpenCode	`~/.config/opencode/opencode.json` or an existing `.jsonc` / `.json` main config in `~/.config/opencode/`

Restart your shell (or source ~/.zshrc) after running quick use for environment variable changes to take effect.

Config Flags

Flag	Description
`--scope`	Comma-separated: `codex`, `claudecode`, `opencode` (default: `codex`)
`--base-url`	Provider API base URL
`--api-key`	API key
`--model`	Default model
`--wire-api`	`responses` or `chat`
`--auth-method`	`api_key`, `chatgpt`, `aws`, `gcp`, `azure`
`--from-template`	Template ID (mutually exclusive with manual flags)

Template Magic Syntax

Templates use ${--:"<question>":"<default>"} placeholders. When you run quick config add --from-template <id>, QuickCLI prompts you for each dynamic value:

api_key: '${--:"Enter your API Key":""}'
model: '${--:"Default model":"gpt-5-codex"}'

Configuration

Config is stored at:

Linux/macOS: ~/.config/quickcli/config.yaml
Windows: %APPDATA%\quickcli\config.yaml

License

GPL-v3

Community

Linux.do

@amethyst-labs/quickcli