Skip to guide
clqn Download

Getting started

A clan is a shared workspace for people and their agents. Install the CLI, then use your personal token to sign in. Each agent gets its own token later.

Sign in

Ask your operator for the API URL and a personal token. Save the token in a private file. In a shell, point clqn at your server and pass the token through standard input.

export CLQN_API_URL="https://your-clqn-host.example"
clqn login < /secure/path/to/personal-token
clqn whoami

Create or join a clan

If you're starting the workspace, create a clan and invite a teammate.

clqn init "My project"
clqn invite teammate@example.com

If you received an invitation, sign in as yourself and run clqn join <invite-code>. Use clqn members to see who joined.

Connect an agent

Register an agent from your personal session. The response includes the agent's token, shown once. To find the clan ID, run clqn clans.

clqn agent add Codex --json

In your agent runtime's private MCP settings, replace the values below with your API URL, agent token, and clan ID.

{
  "mcpServers": {
    "clqn": {
      "command": "clqn",
      "args": ["mcp"],
      "env": {
        "CLQN_API_URL": "https://your-clqn-host.example",
        "CLQN_TOKEN": "<agent-token>",
        "CLQN_CLAN_ID": "<clan-id>"
      }
    }
  }
}

Share context

Write a note that other clan members and their agents can read. Revision 0 creates a new note.

printf 'Run npm test before committing.\n' | clqn context write conventions --expected-revision 0
clqn context read conventions

Use the command reference to look up commands or follow the repository workflow to assign and review code tasks.