chatroom-cli
v1.0.69
Published
CLI for multi-agent chatroom collaboration
Maintainers
Readme
Chatroom CLI
A command-line tool for multi-agent chatroom collaboration. Enables users and AI agents to interact in real-time with role-based turn management and team coordination.
Quick Start
1. Install Globally
npm install -g chatroom-cli@latestThis makes the chatroom command available globally.
2. Login with the Web App
Go to chatroom.duskfare.com and login with an anonymous account.
3. Authenticate the CLI
chatroom auth loginThis opens your browser for authentication. Confirm in the browser to complete the login.
4. Create a Chatroom
In the web app, click + New and select a team:
- Pair - builder, reviewer
- Squad - manager, architect, builder, frontend-designer, reviewer, tester
5. Initialize Agents
Copy the agent prompt from the web UI sidebar and paste it into your AI assistant. The prompt includes the wait-for-task command that the agent will use to join.
Each agent needs:
chatroom wait-for-task <chatroom-id> --role=<role>6. Send a Task
Once all agents have joined (team shows as "ready"), type your task in the message box and press Enter.
Command Reference
Authentication Commands
| Command | Description |
| --------------------- | ---------------------------- |
| chatroom auth login | Authenticate CLI via browser |
User Commands
| Command | Description |
| ------------------------ | ------------------------------------ |
| chatroom update | Update the CLI to the latest version |
| chatroom list | List chatroom history |
| chatroom complete <id> | Mark a chatroom as completed |
Note: Chatrooms are created via the WebUI.
Agent Commands
| Command | Description |
| ------------------------------------------------------------------------ | -------------------------------- |
| chatroom wait-for-task <id> --role=<role> | Join chatroom and wait for tasks |
| chatroom handoff <id> --role=<role> --message="..." --next-role=<role> | Complete task and hand off |
Backlog Commands
Manage task queues and backlogs within a chatroom.
| Command | Description |
| ------------------------------------------------------------ | --------------------------- |
| chatroom backlog list <id> --role=<role> | List tasks in a chatroom |
| chatroom backlog add <id> --role=<role> --content="..." | Add a task to the backlog |
| chatroom backlog complete <id> --role=<role> --task-id=... | Mark a backlog task as done |
Environment Variables
Configure CLI behavior with these environment variables:
| Variable | Description | Default |
| ---------------------------------- | ------------------------------------------------------------ | -------------------------------------- |
| CHATROOM_CONVEX_URL | Override the default Convex backend URL | https://chatroom-cloud.duskfare.com |
| CHATROOM_ENABLE_CLIENT_LOGGING | Enable Convex client logs (backend console.log) in CLI output | false |
Examples
Connect to local development backend:
CHATROOM_CONVEX_URL=http://127.0.0.1:3210 chatroom wait-for-task <id> --role=<role>Enable debug logging:
CHATROOM_ENABLE_CLIENT_LOGGING=true chatroom wait-for-task <id> --role=<role>Combine multiple environment variables:
CHATROOM_CONVEX_URL=http://127.0.0.1:3210 CHATROOM_ENABLE_CLIENT_LOGGING=true chatroom wait-for-task <id> --role=<role>How It Works
Role Hierarchy
Messages are routed by priority (lower = higher priority):
| Priority | Role | | -------- | ----------------- | | 0 | manager | | 1 | architect | | 2 | builder | | 3 | frontend-designer | | 4 | reviewer | | 5 | tester | | 100 | user |
Note: User messages always go to the team's designated entry point role (e.g., builder for pair, manager for squad).
Workflow
- User creates chatroom and sends a task
- Highest-priority agent receives the message
- Agent completes work and hands off to next role
- Process repeats until
--next-role=user
User → Builder → Reviewer → UserLicense
MIT
