CLI Reference

Complete reference for every cliq command, organized by category.

Quick Start

Install cliq and run first-time setup:

curl -fsSL https://getcliq.io/cliq/install | bash -s -- --key cliqhub-early-2026
cliq setup

Check the installed version:

cliq --version

Display help for any command:

cliq --help
cliq <command> --help
cliq <command> <subcommand> --help

Command Summary

Global

Command	Description
`cliq setup`	One-time global setup — creates `~/.cliqrc/` and default settings
`cliq settings`	Read, write, and inspect configuration

Project

Command	Description
`cliq init`	Initialize `.cliq/` directory in the current project
`cliq assemble`	Deploy a team to the current project
`cliq req`	Resolve requirements and generate prompts, channels, and task board
`cliq run`	Launch all agents in a tmux session
`cliq status`	Display pipeline progress
`cliq doctor`	Check environment and integrations
`cliq auth google`	Manage Google OAuth2 authentication
`cliq clean`	Remove all cliq artifacts from the project

Builder

Command	Description
`cliq builder generate`	Generate a complete team from a natural language description
`cliq builder improve`	Improve a single role using the LLM
`cliq builder gaps`	Analyse a team for gaps and suggest improvements
`cliq builder capability`	Generate or regenerate A2A metadata (tags, use_when, not_for)

Hub

Command	Description
`cliq hub login`	Authenticate with a registry
`cliq hub logout`	Clear hub and HUG credentials
`cliq hub token`	Create an API token

Team Management

Command	Description
`cliq team new`	Create a new empty team
`cliq team install`	Install a team from a local path or hub:// registry
`cliq team update`	Update installed teams to latest versions
`cliq team uninstall`	Remove an installed team
`cliq team publish`	Publish a team from a local path to a registry
`cliq team copy`	Copy a team to a local directory
`cliq team add-role`	Add a role to a team
`cliq team remove-role`	Remove a role from a team
`cliq team gen-workflow`	Generate workflow from roles, or import from a file
`cliq team edit-workflow`	Open team.yml in your editor
`cliq team validate`	Validate a team definition
`cliq team version`	Bump the team’s semantic version
`cliq team list`	List installed teams with versions and source
`cliq team info`	Show detailed team information (local or hub://)

Instance

Command	Description
`cliq instance list`	List all active cliq tmux sessions
`cliq instance attach`	Attach to a cliq tmux session
`cliq instance kill`	Kill a cliq tmux session

Server

Command	Description
`cliq server start`	Start the local cliq server
`cliq server stop`	Stop the running cliq server
`cliq server status`	Show cliq server status

Tool

Command	Description
`cliq tool run`	Run a tool by name
`cliq tool list`	List all available tools
`cliq tool run pr-exists`	Check if an open PR exists for the current branch
`cliq tool run create-pr`	Create a pull request via the configured git provider
`cliq tool run pull`	Pull external content into workspace
`cliq tool run push`	Push local file to external destination

Global Commands

cliq setup

Interactive setup wizard. Walks you through configuring your cliq environment: prerequisites, default agent, integrations, and credentials. Creates ~/.cliqrc/ with settings and an empty local team registry (teams/@local/) on first run.

Re-runnable — on subsequent runs, shows current values as defaults. Press Enter to keep them, or type a new value to change.

cliq setup [options]

Option	Description
`--import <path>`	Import a `settings.json` file (skips the wizard)
`--reset`	Wipe `~/.cliqrc/` and start fresh (prompts for confirmation)
`--force`	Skip confirmations (use with `--reset` or `--import`)
`--non-interactive`	Accept all defaults without prompting (for CI/scripting)

The wizard covers:

Prerequisites — checks for Node.js and tmux
Import — optionally load settings from another machine
Default agent — choose cursor, claude-code, gemini, or codex, and set the API key
Instance ID prefix — optional prefix for tmux session names
CliqHub — log in to browse, install, and publish teams
Source control — GitHub or Bitbucket integration for branches and PRs
Jira — issue tracking and gate escalation
Slack — pipeline notifications via webhook
Google — Drive, Docs, and Sheets access
Microsoft — SharePoint and OneDrive access
AI Team Builder — LLM provider for AI-assisted team creation
Diagnostics — verifies the resulting configuration

cliq setup                                      # Interactive wizard
cliq setup --import ~/team-config/settings.json  # Import settings
cliq setup --reset                               # Factory reset
cliq setup --non-interactive                     # Bootstrap with defaults

cliq settings

Read, write, and inspect configuration with git config-like semantics. Supports two scopes (global and project), dot-notation keys, schema-based type coercion, array operations, and secret masking.

cliq settings [key] [value] [options]

When called with no key, lists all settings. When called with a key that maps to an object, lists all keys under that section. When called with a leaf key, prints the value (or (not set) with exit code 1 if valid but unconfigured). Unknown keys produce an error with a contextual --info hint pointing to the deepest valid section. When called with a key and value, writes the value.

Option	Description
`--global`	Target global settings (`~/.cliqrc/settings.json`)
`--project`	Target project settings (`.cliq/settings.json`)
`--unset <key>`	Remove a key from the target file
`--add <key>`	Append a value to an array field
`--remove <key>`	Remove a value from an array field
`--stdin`	Read the value from stdin instead of the command line
`--unmask`	Show unmasked secret values (tokens, API keys)
`--info`	Show documentation for a setting or section. Non-leaf results include a navigation hint.

Scope and Precedence

Without --global or --project, reads show the merged (resolved) view — project values override global. Writes default to the project scope; if not inside a project, they fall back to global.

Flag	Reads from	Writes to
(none, inside project)	merged (global + project)	`.cliq/settings.json`
(none, outside project)	`~/.cliqrc/settings.json`	`~/.cliqrc/settings.json`
`--global`	`~/.cliqrc/settings.json`	`~/.cliqrc/settings.json`
`--project`	`.cliq/settings.json`	`.cliq/settings.json`

Type Coercion

Values are coerced based on the schema derived from the settings template:

Boolean fields accept true or false (case-insensitive).
Number fields must parse to a valid number.
Enum fields must match one of the allowed values (e.g., logging.server_level accepts error, warn, info, debug, trace).
Array fields cannot be set directly — use --add and --remove.
Object keys cannot be set directly — set leaf keys instead.

Secret Masking

Fields that hold credentials (tokens, API keys) are masked by default — only the first 4 characters are shown, followed by ****. This applies to both simple leaf fields and secret fields inside array elements (e.g., client_secret within mesh entries). Use --unmask to reveal full values.

Examples

# Read a value
cliq settings integrations.github.base_branch

# Write a string
cliq settings integrations.github.base_branch develop

# Write at global scope
cliq settings integrations.github.base_branch develop --global

# Write a secret from stdin
echo $TOKEN | cliq settings hub.token --stdin --global

# List all resolved settings
cliq settings

# List global settings only
cliq settings --global

# Read an entire section
cliq settings integrations.github

# Array: append
cliq settings --add integrations.github.pr_labels deploy --global

# Array: remove
cliq settings --remove integrations.github.pr_labels auto

# Unset a key
cliq settings --unset integrations.github.pr_draft

# Show a secret unmasked
cliq settings hub.token --unmask --global

# Show documentation for all sections
cliq settings --info

# Show documentation for a section
cliq settings integrations.github --info

# Show full detail for a setting (type, default, description, JSON, CLI examples)
cliq settings integrations.github.finalize_to --info

# Read a valid but unconfigured key — prints "(not set)", exit code 1
cliq settings integrations.github.token

# Unknown key — error with contextual hint
# error: Unknown key 'integrations.jira.badkey'.
#   Run 'cliq settings integrations.jira --info' to navigate the integrations.jira schema.
cliq settings integrations.jira.badkey

Project Commands

cliq init

Initialize the .cliq/ directory structure in the current project.

cliq init [options]

Option	Description
`--id <id>`	Set a specific instance ID
`--id-prefix <prefix>`	Generate instance ID with a custom prefix (e.g. `myproject` → `myproject-a1b2c3`)

--id and --id-prefix are mutually exclusive. The prefix can also be set via id_prefix in settings.

cliq init
cliq init --id my-pipeline
cliq init --id-prefix myproject

cliq assemble

Deploy a team from the registry into the current project. Creates .cliq/roles/, workflow.yml, and the channel structure. Run from a project directory (or multi-repo workspace root) that has been initialized with cliq init.

cliq assemble <team> [options]

Argument	Description
`team`	Team name or scoped reference

Option	Description
`--dir <path>`	Resolve team from a local directory instead of the install directory

Accepts scoped references (@cliq/feature-dev-js) or bare names (feature-dev-js). Bare names are resolved in order: @local → other @* scopes.

During assembly, cliq generates an agents.json manifest and warns about custom agents that need user configuration:

⚠ Agent 'custom-agent' has no entry point — configure it in settings.json under agents.custom before running

See Cliq SDK for details on agents and assembly.

cliq assemble feature-dev-js
cliq assemble @cliq/feature-dev-js
cliq assemble my-team --dir ./teams/my-team

cliq req

Resolve requirements and generate prompts, channels, and the task board.

cliq req [options]

Option	Description
`-s, --source <ref>`	Source for requirements — file path, URL, or URI scheme (e.g. `jira:KEY`)
`-m, --message <text>`	Use an inline string as the requirement
`--stdin`	Read requirement text from stdin
`--nospec`	Start workflow with default requirements (no spec needed)
`--no-docker`	Run without Docker
`-i, --input <key=value...>`	Provide team input values (repeatable)

Only one input source is allowed per invocation: -s, -m, --stdin, or --nospec.

Source resolution: The -s flag accepts file paths, full URLs, and URI schemes. The scheme determines how the source is resolved:

Source	Resolution
`-s requirements.md`	Local file
`-s https://example.com/spec.md`	HTTP fetch
`-s jira:PROJ-123`	Jira ticket (requires `integrations.jira` in settings)
`-s jira:PROJ-1,PROJ-2`	Multiple Jira tickets

Bare paths (no scheme) are treated as local files.

Validation gate: Before executing, cliq req checks that all prerequisites are met — a requirement spec and any inputs defined by the team. If anything is missing, it prints exactly what’s needed and a copy-paste example command, then exits without touching project state. This applies whether you omit the spec entirely or provide a spec but forget an --input flag.

Input resolution: Team inputs are resolved exclusively from --input flags (or interactive prompts in non-headless mode). They are not parsed from the requirement text.

# Check what the team needs (no spec, shows what's missing)
cliq req

# Provide everything — runs the pipeline
cliq req -s requirements.md
cliq req -s requirements.md --input company=acme --input year=2026
cliq req -s https://example.com/spec.md
cliq req -s jira:PROJ-123
cliq req -s jira:PROJ-100,PROJ-101,PROJ-102
cliq req -m "Build a REST API with JWT auth and role-based access control"
echo "Build a hello world app" | cliq req --stdin
cat spec.txt | cliq req --stdin
cliq req --nospec
cliq req -s requirements.md --no-docker

cliq run

Launch all agents in a tmux session and run the pipeline.

cliq run [options]

Option	Description
`-f, --force`	Skip confirmation when re-running after a failed pipeline
`-H, --headless`	Run orchestrator in foreground, agents in background tmux
`-a, --agent <name>`	Override the default agent (e.g. `claude-code`, `gemini`)
`--docker`	Run pipeline inside a Docker container
`--no-docker`	Force local executor (bypass `docker.enabled` and `kubernetes.enabled`)
`--dashboard`	With `--docker`: require server, suppress terminal streaming

Pre-flight checks: Before launching, cliq run verifies that all prerequisite steps have been completed — project initialized, team assembled, requirements set, and prompts generated. If the team defines inputs, cliq run also checks that inputs.json contains all required values. If any are missing, it fails with a message to re-run cliq req with the appropriate --input flags.

When docker.enabled is true in settings, Docker is the default. When kubernetes.enabled is true, K8s takes precedence. --no-docker bypasses both. See Docker Container Isolation and Kubernetes Deployment. See Cliq SDK for -a/--agent details.

cliq run
cliq run -f
cliq run -H
cliq run --agent claude-code
cliq run --docker --dashboard
cliq run --no-docker

cliq status

Display pipeline progress, phase state, and verdicts.

cliq status [options]

Option	Description
`-v, --verbose`	Show detailed diagnostics (verdicts, timing, settings, logs)

cliq status
cliq status -v

cliq doctor

Check local environment dependencies (Node.js, agent CLI, tmux, git), check hug server connectivity (when configured), and optionally verify a team’s tools.

cliq doctor [team_ref]

Argument	Description
`team_ref`	Team reference to check required tools (optional)

cliq doctor
cliq doctor @cliq/feature-dev-js

cliq doctor test

Test integration connectivity.

cliq doctor test <target> [options]

Argument	Description
`target`	Integration to test: `github`, `bitbucket`, `slack`, `jira`, `google`, `microsoft`, or `all`

Option	Description
`--ticket <key>`	Jira ticket key to verify project access (used with `jira` target)

cliq doctor test github
cliq doctor test jira --ticket PROJ-123
cliq doctor test google
cliq doctor test microsoft
cliq doctor test all

cliq auth google

Manage Google OAuth2 authentication. Default action runs the interactive browser-based authorization flow.

cliq auth google [options]

Option	Description
`--status`	Show current token status (stored, valid, expired)
`--revoke`	Revoke token with Google and clear local storage
`--client-file <path>`	Path to OAuth client secrets JSON (overrides settings)

cliq auth google                            # run the authorization flow
cliq auth google --client-file ~/client.json  # specify client file explicitly
cliq auth google --status                   # check token status
cliq auth google --revoke                   # revoke and clear

The client secrets file is resolved from (in order): --client-file flag, then integrations.google.oauth_client_file in settings.json. After authorization, the refresh token is stored at ~/.cliqrc/google_token.json with restrictive permissions (0600).

See Integrations — Google for the full OAuth setup guide.

cliq clean

Remove all cliq artifacts from the project (.cliq/ and generated config files).

cliq clean [options]

Option	Description
`-f, --force`	Skip confirmation prompt

cliq clean
cliq clean -f

Builder Commands

AI-powered team generation and refinement. All builder commands require a configured LLM provider in ~/.cliqrc/settings.json under the builder section. Every subcommand accepts --provider and --model flags to override the configured defaults for a single invocation.

cliq builder generate

Generate a complete team from a natural language description. Exactly one input source is required. Destination follows the same scope resolution as team new — bare names go to @local/, scoped names resolve to ~/.cliqrc/teams/@scope/.

cliq builder generate -f <file> [path] [options]
cliq builder generate -m <text> [path] [options]
cliq builder generate --stdin [path] [options]

Input (exactly one required)	Description
`-f, --file <path>`	Read instructions from a file
`-m, --message <text>`	Use an inline string as the instructions
`--stdin`	Read instructions from stdin

Argument	Description
`path`	Write to a specific directory instead of the resolved default (optional)

Option	Description
`--name <name>`	Override the LLM-generated team name (supports `@scope/name`)
`--dry-run`	Show what would be created without writing files
`--force`	Overwrite if a team with the same name already exists
`--provider <name>`	LLM provider override (`openai`, `anthropic`, `google`)
`--model <model>`	Model override (e.g. `gpt-4o`, `claude-sonnet-4-20250514`)

The generated team includes a team.yml with workflow phases, role files for each agent, and A2A metadata fields (tags, inputs, use_when, not_for). The team is validated before installation — if validation fails, errors are displayed and nothing is written.

cliq builder generate -m "TDD pipeline for a Python FastAPI project"
cliq builder generate -f spec.txt --name @myorg/content-review
cliq builder generate -f spec.txt --name @myorg/sec-audit ~/myorg-teams
cat spec.txt | cliq builder generate --stdin --dry-run

cliq builder improve

Improve a single role in an existing team using the LLM.

cliq builder improve <team> --role <role> [options]

Argument	Description
`team`	Team name or scoped reference

Option	Description
`--role <role>`	Role to improve (required)
`--dir <path>`	Resolve team from a local directory instead of the install directory
`--instruction <text>`	Specific improvement instruction (reads from stdin when set to `-`)
`--dry-run`	Preview the improved role without writing
`--provider <name>`	LLM provider override
`--model <model>`	Model override

Without --instruction, the LLM uses its own judgement to improve the role based on the team’s context. With an instruction, it targets a specific aspect.

cliq builder improve my-team --role architect
cliq builder improve my-team --role reviewer --instruction "add security review checklist"
cliq builder improve @local/my-team --role developer --dry-run
echo "focus on error handling" | cliq builder improve my-team --role developer --instruction -

cliq builder gaps

Analyse an existing team for gaps and suggest improvements — missing phases, workflow issues, or coverage holes.

cliq builder gaps <team> [options]

Argument	Description
`team`	Team name or scoped reference

Option	Description
`--provider <name>`	LLM provider override
`--model <model>`	Model override

Prints a numbered list of suggestions with type, title, description, and optionally a suggested phase or role.

cliq builder gaps my-team
cliq builder gaps @cliq/feature-dev-js

cliq builder capability

Generate or regenerate A2A metadata (tags, use_when, not_for) for an existing team. The metadata fields are written as top-level keys in team.yml and enable A2A discovery.

cliq builder capability <team> [options]

Argument	Description
`team`	Team name or scoped reference

Option	Description
`--dry-run`	Preview the A2A metadata without writing to `team.yml`
`--provider <name>`	LLM provider override
`--model <model>`	Model override

cliq builder capability my-team
cliq builder capability my-team --dry-run
cliq builder capability @local/my-team --provider anthropic --model claude-sonnet-4-20250514

Hub Commands

Authentication with CliqHub registries. All team operations (install, update, publish, info) are under Team Management Commands. Use the CliqHub web UI for browsing and searching teams.

Authenticate with a CliqHub registry. Prompts for username and password. On success, saves the JWT token to ~/.cliqrc/settings.json under hub.token. If the registry has a HUG server integrated, also provisions a HUG user JWT and writes hug.server_url and hug.token to settings.

cliq hub login [registry_url]

Argument	Description
`registry_url`	Registry URL (optional; defaults to `settings.hub.registry_url`)

cliq hub login
cliq hub login https://internal.corp/registry

cliq hub logout

Clear hub and HUG credentials from ~/.cliqrc/settings.json. Removes hub.token, hug.token, and hug.server_url. Other settings (like hub.registry_url and hug.reviewers) are preserved.

cliq hub logout

cliq hub logout

cliq hub token

Generate a named API token for headless/CI use. The token is shown once and must be saved — it cannot be retrieved again.

cliq hub token <name> [registry_url]

Argument	Description
`name`	Name for the token (for identification)
`registry_url`	Registry URL (optional; defaults to `settings.hub.registry_url`)

Requires cliq hub login first.

cliq hub token ci-publish
cliq hub token deploy-key https://internal.corp/registry

Team Management Commands

Commands for managing, inspecting, and manually assembling teams. For AI-powered team creation, see Builder Commands. For registry authentication, see Hub Commands.

Teams are stored in the registry at ~/.cliqrc/teams/. They can be referenced as bare names (feature-dev-js) or scoped (@cliq/feature-dev-js). Bare names go to @local/. Scoped names resolve to ~/.cliqrc/teams/@scope/.

cliq team new

Create a new empty team.

cliq team new <name> [path]

Argument	Description
`name`	Team name — bare (`my-team`) or scoped (`@myorg/my-team`)
`path`	Write to a specific directory instead of the resolved default (optional)

cliq team new my-pipeline
cliq team new @myorg/my-pipeline
cliq team new @myorg/my-pipeline ~/myorg-teams

cliq team install

Install a team from a local path or a hub:// registry URI.

cliq team install <source> [options]

Argument	Description
`source`	Local filesystem path or `hub://@scope/name[@version]`

Option	Description
`--force`	Reinstall even if the same version is already installed; skip all confirmation prompts

Local installs read team.yml from the path. Unscoped teams go to @local. Hub installs download from settings.hub.registry_url. Both write a .cliq-source provenance marker.

When installing over an existing team (same @scope/name already installed), the user must type the full team name to confirm the overwrite. Fresh installs (no existing team) proceed without prompts. Use --force to skip all prompts.

cliq team install ./my-team
cliq team install ./@acme/my-pipeline
cliq team install hub://@acme/my-pipeline
cliq team install hub://@acme/[email protected]
cliq team install ./my-team --force

cliq team update

Update installed teams to latest versions. Checks all installed teams that have a .cliq-source provenance marker. Hub-sourced teams are checked against the registry. Local-sourced teams are checked against their original path.

cliq team update [ref] [options]

Argument	Description
`ref`	Specific team to update (optional)

Option	Description
`-f, --force`	Skip confirmation prompt

cliq team update
cliq team update @acme/deploy
cliq team update --force

cliq team uninstall

Remove an installed team from ~/.cliqrc/teams/.

cliq team uninstall <ref>

Argument	Description
`ref`	Team to remove (`@scope/name`)

cliq team uninstall @acme/my-pipeline
cliq team uninstall @local/my-team

cliq team copy

Copy a team from the registry to a local directory. Optionally rewrite the team’s scope and name in team.yml.

cliq team copy <source> <dest> [scope]

Argument	Description
`source`	Source registry reference (e.g. `@cliq/feature-dev-js`)
`dest`	Local directory path (must not exist; will be created)
`scope`	Optional — rewrite `team.yml` name: `@acme` (scope only, keeps bare name) or `@acme/my-tdd` (full ref, changes both scope and name). If omitted, `team.yml` is left untouched.

cliq team copy @cliq/feature-dev-js ./my-tdd
cliq team copy @cliq/hello-world ./my-hello @myorg
cliq team copy @cliq/feature-dev-js ./my-tdd @myorg/my-tdd
cliq team copy @local/my-experiment ./my-experiment-v2

cliq team add-role

Add a role to a team.

cliq team add-role <team> <role> [options]

Argument	Description
`team`	Team to add the role to
`role`	Role name to add

Option	Description
`--from <path>`	If `--from` is provided, copies from the given file path. Otherwise creates a blank role file.

cliq team add-role my-pipeline reviewer
cliq team add-role my-pipeline my-reviewer --from ./templates/reviewer.md

cliq team remove-role

Remove a role from a team.

cliq team remove-role <team> <role>

Argument	Description
`team`	Team to remove the role from
`role`	Role to remove

cliq team remove-role my-pipeline reviewer

cliq team gen-workflow

Generate a sequential workflow from the team’s roles, or import a workflow from a file.

cliq team gen-workflow <team> [file] [options]

Argument	Description
`team`	Team to generate the workflow for
`file`	YAML file to import as the workflow (optional)

Option	Description
`--edit`	Open `team.yml` in editor after generating

If the team already has a workflow, you are prompted to confirm replacement.

cliq team gen-workflow my-pipeline
cliq team gen-workflow my-pipeline workflow.yml --edit

cliq team edit-workflow

Open a team’s team.yml in your editor.

cliq team edit-workflow <team>

Argument	Description
`team`	Team whose workflow to edit

Vendor teams (@cliq scope) cannot be edited directly — copy first with cliq team copy.

cliq team edit-workflow my-pipeline

cliq team validate

Validate a team definition for consistency.

cliq team validate <name>

Argument	Description
`name`	Team to validate

cliq team validate my-pipeline

cliq team publish

Publish a team from a local path to a CliqHub registry. Reads name, scope, and version from team.yml. Rejects @local scope.

cliq team publish <path> [registry] [options]

Argument	Description
`path`	Local filesystem path to the team
`registry`	Target registry URL (optional; defaults to `settings.hub.registry_url`). Use `hub://` to be explicit about the default

Option	Description
`--access <level>`	Visibility: `public` (default), `private`, or `draft`
`-m, --message <text>`	Changelog message for this version

Requires cliq hub login first.

cliq team publish ./@myorg/tdd-pipeline
cliq team publish ./my-team --access private
cliq team publish ./@myorg/tdd-pipeline hub://
cliq team publish ./@myorg/tdd-pipeline https://other.registry
cliq team publish ./@myorg/tdd-pipeline -m "Added security audit phase"

cliq team version

Bump the semantic version in a team’s team.yml. If the team is in a git repository, automatically stages the file, commits with message vX.Y.Z, and creates a git tag. See Versioning for details.

cliq team version <bump> [ref] [options]

Argument	Description
`bump`	Bump type: `patch`, `minor`, or `major`
`ref`	Team reference (optional — defaults to the team in the current directory)

Option	Description
`--no-git`	Skip git commit and tag

If no version exists yet, any bump type produces 1.0.0.

cliq team version patch @myorg/my-pipeline          # 1.2.0 → 1.2.1
cliq team version minor @myorg/my-pipeline          # 1.2.0 → 1.3.0
cliq team version major @myorg/my-pipeline          # 1.2.0 → 2.0.0
cliq team version patch @myorg/my-pipeline --no-git  # skip git operations

cliq team list

List installed teams with versions and source, grouped by scope. Each team’s team.yml is validated during listing — issues are surfaced inline with a ⚠ warning:

Unparseable YAML — the file could not be parsed.
Missing name — the name field is absent.
Bare name — the name is not in the required @scope/name format.
Name / directory mismatch — the name in team.yml does not match the directory structure.
Unscoped directory — the team directory is not inside a @scope/ parent.

cliq team list

Example output:

Teams:

  @cliq
    tdd
    tdd-git

  @local
    my-team
    broken-team  ⚠ team.yml missing "name" field

cliq team info

Show detailed team information. Use hub://@scope/name for registry info. Displays workflow DAG, phases, roles, external data, and A2A metadata. Emits a warning if the team.yml name does not match the directory-derived reference.

cliq team info <ref> [--brief]

Argument	Description
`ref`	Team to display (`@scope/name` or `hub://@scope/name`)

Option	Description
`--brief`	Compact one-line-per-field output

cliq team info @cliq/feature-dev-js
cliq team info @local/my-pipeline
cliq team info hub://@acme/deploy
cliq team info @cliq/feature-dev-js --brief

Instance Commands

Each cliq run creates a tmux session whose name is the instance ID (e.g. myproject-a1b2c3), enabling multiple concurrent pipelines across different projects (or A2A tasks). When instance_id is omitted from commands below, it is read from .cliq/cliq.id in the current directory.

cliq instance list

List all active cliq tmux sessions across all projects.

cliq instance list

Shows the instance ID for each active session.

cliq instance attach

Attach to a cliq tmux session.

cliq instance attach [instance_id]

Argument	Description
`instance_id`	Instance to attach to (optional; defaults to current project)

cliq instance attach
cliq instance attach myproject-a1b2c3

cliq instance kill

Kill a cliq tmux session.

cliq instance kill [instance_id]

Argument	Description
`instance_id`	Instance to kill (optional; defaults to current project)

cliq instance kill
cliq instance kill myproject-a1b2c3

Server Commands

The local server provides an HTTP/WebSocket API for the dashboard, A2A agent communication, and mesh networking.

cliq server start

Start the local cliq server.

cliq server start [options]

Option	Description
`-p, --port <port>`	Port number (default: `4100`)
`--a2a`	Enable A2A agent mode (join configured meshes)
`--mesh <names...>`	Activate specific mesh(es) by name (implies `--a2a`)
`--public-url <url>`	Public URL for agent card and mesh registration (e.g. ngrok tunnel; implies `--a2a`)

cliq server start
cliq server start -p 8080
cliq server start --a2a
cliq server start --mesh production staging
cliq server start --public-url https://abc123.ngrok.io

cliq server stop

Stop the running cliq server.

cliq server stop

cliq server status

Show server status including PID, port, and uptime.

cliq server status

Tool Commands

Built-in verification tools used by workflow checks and agents. Each tool exits with code 0 on success and 1 on failure.

cliq tool run

Run a built-in tool by name. Each tool exits with code 0 on success and 1 on failure.

cliq tool run <name>

Argument	Description
`name`	Tool name (`pull`, `push`, `pr-exists`, `create-pr`)

cliq tool run pr-exists

Check whether an open pull request exists for the current branch. Works with both GitHub and Bitbucket Cloud — the provider is auto-detected from the git remote URL.

cliq tool run pr-exists

Reads the current branch and remote URL from git, then queries the provider API. Exits 0 if an open PR is found, 1 otherwise. Commonly used in exec phase commands:

- name: git-verify
  type: exec
  commands:
    - name: pr-exists
      run: "cliq tool run pr-exists"

Requires provider credentials in integrations.github or integrations.bitbucket. See Integrations for setup.

cliq tool run create-pr

Create a pull request via the configured git provider. Reads the current branch, remote URL, and builds the PR title and body from the task board and req spec. Returns the PR URL on success.

cliq tool run create-pr

Used by the git-finalize agent to create PRs without direct API calls, making the agent provider-agnostic. For GitHub, also applies labels and requests reviewers if configured in settings.

Requires the same provider credentials as pr-exists. See Integrations for setup.

cliq tool run pull

Pull external content into the workspace. An escape hatch for dynamic, mid-pipeline pulls.

cliq tool run pull <url> --name <slug> [--format raw]

Argument/Option	Description
`url`	Source URL to fetch
`--name <slug>`	Name slug for the pulled content (required)
`--format <format>`	`auto` (default) or `raw` — controls conversion

cliq tool run pull https://example.com/report.html --name market-report
cliq tool run pull https://example.com/data.xlsx --name raw-data --format raw

cliq tool run push

Push a local file to an external destination. An escape hatch for dynamic, mid-pipeline pushes.

cliq tool run push <file> --to <dest> [--mode <mode>] [--name <title>]

Argument/Option	Description
`file`	Local file path relative to project root
`--to <dest>`	Destination URI (required)
`--mode <mode>`	`create` (default), `append`, or `replace`
`--name <title>`	Name for the created file (used with `create` mode)

cliq tool run push reports/analysis.md --to "gdoc://abc123" --mode replace
cliq tool run push deliverable.pdf --to "gdrive://folder-id/" --mode create --name "Final Report"

cliq tool list

List all available tools with their descriptions.

cliq tool list

Exit Codes

Code	Meaning
`0`	Success
`1`	Failure — invalid arguments, command error, tool failure, or failed environment check

Commands that encounter errors set process.exitCode = 1. Uncaught exceptions and unhandled promise rejections also result in exit code 1.

Environment Variables

Variable	Description
`CLIQ_HOME`	Override the default cliq home directory (`~/.cliqrc`)
`EDITOR`	Editor opened by `team edit-workflow` and `--edit` flags