council-cli 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/README.md +57 -43
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,91 +11,105 @@ AI-powered implementation planning using multiple LLMs that debate and synthesiz
11
11
  ## Installation
12
12
 
13
13
  ```bash
14
- # Clone the repository
15
- git clone https://github.com/your-username/council.git
16
- cd council
17
-
18
- # Install dependencies
19
- bun install
20
- # or
21
- npm install
14
+ npm install -g council-cli
22
15
  ```
23
16
 
24
17
  ## Usage
25
18
 
26
19
  ```bash
27
- # Basic usage
28
- bun run src/index.ts "your task description"
20
+ # Basic usage (always wrap your task in quotes!)
21
+ council "your task description"
29
22
 
30
23
  # With custom output file
31
- bun run src/index.ts "add JWT auth" --output auth-plan.md
24
+ council "add JWT auth" --output auth-plan.md
32
25
 
33
26
  # Show help
34
- bun run src/index.ts --help
27
+ council --help
35
28
  ```
36
29
 
37
30
  ### Options
38
31
 
39
32
  | Option | Description |
40
33
  |--------|-------------|
41
- | `-o, --output` | Output file path (default: `plan.md`) |
34
+ | `-o, --output` | Output file name (default: `councilplan.md`) |
42
35
  | `-h, --help` | Show help message |
43
36
 
44
- ## Configuration
37
+ ## Setup
45
38
 
46
- On first run, Council will prompt you for your OpenRouter API key. The configuration is saved to `~/.config/council/config.yaml`.
39
+ On first run, Council will prompt you for your OpenRouter API key:
47
40
 
48
- ### Get an API Key
41
+ ```
42
+ No OpenRouter API key found.
43
+ Get your key at: https://openrouter.ai/keys
49
44
 
50
- 1. Go to [OpenRouter](https://openrouter.ai/keys)
51
- 2. Create an account and generate an API key
52
- 3. Enter the key when prompted
45
+ Enter your OpenRouter API key: sk-or-v1-xxxxx
46
+ ```
53
47
 
54
- ### Config File
48
+ Get your API key at: **https://openrouter.ai/keys**
55
49
 
56
- ```yaml
57
- openrouter_api_key: sk-or-v1-xxxxx
58
- proposer_models:
59
- - anthropic/claude-3.5-sonnet
60
- - openai/gpt-4o
61
- - google/gemini-2.0-flash-exp
62
- - deepseek/deepseek-chat
63
- chairman_model: anthropic/claude-sonnet-4
64
- ```
50
+ The configuration is saved to `~/.config/council/config.yaml` for future use.
51
+
52
+ ## Output
53
+
54
+ All files are saved to a `./llmcouncil/` folder in your current directory:
55
+
56
+ | File | Description |
57
+ |------|-------------|
58
+ | `stage1.md` | All proposals from each model |
59
+ | `stage2.md` | Rankings table and each model's evaluation |
60
+ | `stage3.md` | Chairman's analysis and thinking process |
61
+ | `councilplan.md` | Final synthesized implementation plan |
65
62
 
66
63
  ## Example
67
64
 
68
65
  ```bash
69
- $ bun run src/index.ts "add user authentication with JWT tokens"
66
+ $ council "add user authentication with JWT tokens"
70
67
 
71
68
  🏛️ Council CLI
72
69
 
73
70
  Task: "add user authentication with JWT tokens"
74
71
 
72
+ Output folder: ./llmcouncil/
73
+
75
74
  [1/3] Generating proposals from models...
76
- Calling 4 models in parallel...
77
- anthropic/claude-3.5-sonnet
78
- openai/gpt-4o
79
- google/gemini-2.0-flash-exp
80
- ✓ deepseek/deepseek-chat ✓
75
+ anthropic/claude-sonnet-4.5
76
+ openai/gpt-5.2-codex
77
+ google/gemini-3-pro-preview
78
+ moonshotai/kimi-k2.5
81
79
 
82
80
  [2/3] Models ranking all plans blindly...
83
- 4 models ranking 4 plans blindly...
84
81
  ✓ All models ranked ✓
85
82
 
86
83
  [3/3] Chairman synthesizing final plan...
87
- ✓ anthropic/claude-sonnet-4 synthesis complete ✓
84
+ ✓ anthropic/claude-opus-4.5 synthesis complete ✓
88
85
 
89
- Plan saved to plan.md
86
+ All files saved to ./llmcouncil/:
87
+ - stage1.md (proposals)
88
+ - stage2.md (rankings)
89
+ - stage3.md (chairman analysis)
90
+ - councilplan.md (final plan)
90
91
  ```
91
92
 
92
- ## Output Format
93
+ ## Configuration
94
+
95
+ Edit `~/.config/council/config.yaml` to customize models:
96
+
97
+ ```yaml
98
+ openrouter_api_key: sk-or-v1-xxxxx
99
+
100
+ proposer_models:
101
+ - anthropic/claude-sonnet-4.5
102
+ - openai/gpt-5.2-codex
103
+ - google/gemini-3-pro-preview
104
+ - moonshotai/kimi-k2.5
105
+
106
+ chairman_model: anthropic/claude-opus-4.5
107
+ ```
93
108
 
94
- The generated `plan.md` includes:
109
+ ## Requirements
95
110
 
96
- - Task description
97
- - Synthesized implementation plan
98
- - Metadata (chairman model, proposal count, ranker count)
111
+ - Node.js >= 18.0.0
112
+ - OpenRouter API key
99
113
 
100
114
  ## License
101
115
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "council-cli",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "AI-powered implementation planning using multiple LLMs that debate and synthesize the best approach",
5
5
  "type": "commonjs",
6
6
  "bin": {