chatroom-cli 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +130 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Chatroom CLI
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
### 1. Install Globally
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g chatroom-cli@latest
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
This makes the `chatroom` command available globally.
|
|
14
|
+
|
|
15
|
+
### 2. Login with the Web App
|
|
16
|
+
|
|
17
|
+
Go to [chatroom.duskfare.com](https://chatroom.duskfare.com) and login with an anonymous account.
|
|
18
|
+
|
|
19
|
+
### 3. Authenticate the CLI
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
chatroom auth login
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This opens your browser for authentication. Confirm in the browser to complete the login.
|
|
26
|
+
|
|
27
|
+
### 4. Create a Chatroom
|
|
28
|
+
|
|
29
|
+
In the web app, click **+ New** and select a team:
|
|
30
|
+
|
|
31
|
+
- **Pair** - builder, reviewer
|
|
32
|
+
- **Squad** - manager, architect, builder, frontend-designer, reviewer, tester
|
|
33
|
+
|
|
34
|
+
### 5. Initialize Agents
|
|
35
|
+
|
|
36
|
+
Copy the agent prompt from the web UI sidebar and paste it into your AI assistant. The prompt includes the `wait-for-message` command that the agent will use to join.
|
|
37
|
+
|
|
38
|
+
Each agent needs:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
chatroom wait-for-message <chatroom-id> --role=<role>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### 6. Send a Task
|
|
45
|
+
|
|
46
|
+
Once all agents have joined (team shows as "ready"), type your task in the message box and press Enter.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Command Reference
|
|
51
|
+
|
|
52
|
+
### Authentication Commands
|
|
53
|
+
|
|
54
|
+
| Command | Description |
|
|
55
|
+
| --------------------- | ------------------------------------- |
|
|
56
|
+
| `chatroom auth login` | Authenticate CLI via browser |
|
|
57
|
+
|
|
58
|
+
### User Commands
|
|
59
|
+
|
|
60
|
+
| Command | Description |
|
|
61
|
+
| ------------------------ | ------------------------------------------------ |
|
|
62
|
+
| `chatroom init` | Initialize configuration file |
|
|
63
|
+
| `chatroom create` | Create chatroom from CLI (alternative to web UI) |
|
|
64
|
+
| `chatroom list` | List chatroom history |
|
|
65
|
+
| `chatroom complete <id>` | Mark a chatroom as completed |
|
|
66
|
+
|
|
67
|
+
### Agent Commands
|
|
68
|
+
|
|
69
|
+
| Command | Description |
|
|
70
|
+
| ------------------------------------------------------------------------------ | ----------------------------------- |
|
|
71
|
+
| `chatroom wait-for-message <id> --role=<role>` | Join chatroom and wait for messages |
|
|
72
|
+
| `chatroom task-complete <id> --role=<role> --message="..." --next-role=<role>` | Complete task and hand off |
|
|
73
|
+
| `chatroom send <id> --message="..." --role=<role>` | Send a message |
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Configuration
|
|
78
|
+
|
|
79
|
+
### Config Location
|
|
80
|
+
|
|
81
|
+
The CLI searches for configuration in this order:
|
|
82
|
+
|
|
83
|
+
1. `.chatroom/chatroom.jsonc` in current directory (or parent directories)
|
|
84
|
+
2. `~/.chatroom/chatroom.jsonc` (global config)
|
|
85
|
+
|
|
86
|
+
### Project-Level Configuration
|
|
87
|
+
|
|
88
|
+
To create a local configuration for a specific project:
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
cd your-project
|
|
92
|
+
chatroom init
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
This creates a local `.chatroom/chatroom.jsonc` that takes precedence.
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## How It Works
|
|
100
|
+
|
|
101
|
+
### Role Hierarchy
|
|
102
|
+
|
|
103
|
+
Messages are routed by priority (lower = higher priority):
|
|
104
|
+
|
|
105
|
+
| Priority | Role |
|
|
106
|
+
| -------- | ----------------- |
|
|
107
|
+
| 0 | manager |
|
|
108
|
+
| 1 | architect |
|
|
109
|
+
| 2 | builder |
|
|
110
|
+
| 3 | frontend-designer |
|
|
111
|
+
| 4 | reviewer |
|
|
112
|
+
| 5 | tester |
|
|
113
|
+
| 100 | user |
|
|
114
|
+
|
|
115
|
+
**Note:** User messages always go to the team's designated entry point role (e.g., `builder` for pair, `manager` for squad).
|
|
116
|
+
|
|
117
|
+
### Workflow
|
|
118
|
+
|
|
119
|
+
1. User creates chatroom and sends a task
|
|
120
|
+
2. Highest-priority agent receives the message
|
|
121
|
+
3. Agent completes work and hands off to next role
|
|
122
|
+
4. Process repeats until `--next-role=user`
|
|
123
|
+
|
|
124
|
+
```
|
|
125
|
+
User → Builder → Reviewer → User
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## License
|
|
129
|
+
|
|
130
|
+
MIT
|