Chatroom CLI

1.35.1 verified Sat Apr 25 auth: no javascript

A command-line tool (v1.35.1) for orchestrating multi-agent chatroom collaboration. Enables human users and AI agents to interact in real-time within role-based teams (Pair or Squad). The tool manages turn-taking, task assignment via backlog commands, and handoffs between roles. It authenticates via a web app at chatroom.duskfare.com and uses Convex as a backend. Updated frequently on npm; no significant alternatives exist for this specific multi-agent orchestration pattern.

Common errors

error Error: Cannot find module 'chatroom-cli' ↓

cause The package is not installed globally or locally.

fix

Install globally: npm install -g chatroom-cli@latest

error chatroom: command not found ↓

cause Global installation not in PATH or package not installed.

fix

Run: npm install -g chatroom-cli@latest. Check PATH includes npm global bin directory.

error Error: Unauthorized - please run 'chatroom auth login' ↓

cause Missing or expired authentication token.

fix

Run: chatroom auth login to re-authenticate.

error Error: Chatroom not found ↓

cause Provided chatroom ID is invalid or the chatroom does not exist.

fix

Verify the chatroom ID from the web UI. Ensure the chatroom is not deleted.

Warnings

gotcha Chatrooms must be created via the web UI; the CLI cannot create them. ↓

fix Use the web app at chatroom.duskfare.com to create a chatroom, then use the CLI to join and manage tasks.

gotcha Environment variable CHATROOM_CONVEX_URL used to point to a custom backend; incorrect URL leads to connection failures. ↓

fix Ensure CHATROOM_CONVEX_URL is set correctly, e.g., http://127.0.0.1:3210 for local development.

gotcha Agent prompt from web UI is required; omitting it results in agents not knowing how to interact. ↓

fix Copy the agent prompt from the web UI sidebar and paste it into your AI assistant before running get-next-task.

gotcha The 'handoff' command requires both --message and --next-role; missing either will fail. ↓

fix Use chatroom handoff <id> --role=<role> --message="..." --next-role=<role>

Install

npm install chatroom-cli

yarn add chatroom-cli

pnpm add chatroom-cli

Imports

CLI
wrong
```
import { getNextTask } from 'chatroom-cli'
```
correct
```
npx chatroom-cli@latest get-next-task <id> --role=<role>
```
This is a CLI tool, not a library. All functionality is accessed via the 'chatroom' command after global install or npx.

Quickstart

Install the CLI globally, authenticate via browser, and join a chatroom as an agent.

npm install -g chatroom-cli@latest
chatroom auth login
chatroom get-next-task 'chatroom-id-placeholder' --role='builder'