Getting Started
Prerequisites
Section titled “Prerequisites”| Requirement | Version / Notes |
|---|---|
| Node.js | 18 or higher — download |
| Agent | At least one — see Agent below |
| tmux | Terminal multiplexer — brew install tmux on macOS |
| git | Required for git-based teams — download |
cliq delegates actual AI work to an agent. The default is Cursor CLI (agent), but any supported agent works:
| Agent | Binary | How to authenticate |
|---|---|---|
| Cursor | agent | Set CURSOR_API_KEY environment variable |
| Claude Code | claude | Run claude login |
| Gemini CLI | gemini | Run gemini auth |
| Codex | codex | Set OPENAI_API_KEY environment variable |
To use a different default agent, add to ~/.cliqrc/settings.json:
"agents": { "default": "claude-code" }Run cliq doctor to verify your agent is installed and authenticated.
Install
Section titled “Install”1. Install the CLI
Section titled “1. Install the CLI”npm install -g @cliqhub/cliq2. Run first-time setup
Section titled “2. Run first-time setup”cliq setupThis creates ~/.cliqrc/ with default settings and an empty local team registry. You only need to do this once.
3. Add official teams
Section titled “3. Add official teams”Teams live in a separate repository. Clone it anywhere on your machine:
Install the official teams from the cloned repo:
cliq team install ./cliq-teams/@cliq/hello-world4. Check your environment
Section titled “4. Check your environment”cliq doctorThis checks Node.js, Cursor CLI, tmux, and git. Fix any issues before continuing.
Next: Run Your First Pipeline
Section titled “Next: Run Your First Pipeline”You’re set up. Head to the Hello World walkthrough to run your first pipeline and learn how all the pieces fit together.