@bradygaster/squad-cli 0.6.0 → 0.6.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.
Files changed (2) hide show
  1. package/README.md +64 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,17 +1,77 @@
1
1
  # @bradygaster/squad-cli
2
2
 
3
- Command-line interface for the Squad multi-agent runtime.
3
+ The programmable multi-agent CLI for GitHub Copilot. Build an AI team, assign roles, and let them work your repo.
4
4
 
5
5
  ## Installation
6
6
 
7
7
  ```bash
8
+ # Global (recommended)
8
9
  npm install -g @bradygaster/squad-cli
10
+
11
+ # Project-local
12
+ npm install --save-dev @bradygaster/squad-cli
13
+
14
+ # One-shot (no install)
15
+ npx @bradygaster/squad-cli
16
+
17
+ # Insider channel (pre-release builds)
18
+ npm install -g @bradygaster/squad-cli@insider
9
19
  ```
10
20
 
11
- ## Usage
21
+ ## Quick Start
12
22
 
13
23
  ```bash
14
- squad --help
24
+ # 1. Initialize Squad in your repo
25
+ squad init
26
+
27
+ # 2. Create your first agent
28
+ squad hire --name aria --role "frontend engineer"
29
+
30
+ # 3. Launch the interactive shell
31
+ squad
15
32
  ```
16
33
 
17
- > **Note:** Source files have not been moved yet — this package is a scaffold for the monorepo split.
34
+ That's it. You have a working AI team.
35
+
36
+ ## Commands
37
+
38
+ | Command | Description |
39
+ |---------|-------------|
40
+ | `squad` | Launch interactive shell |
41
+ | `squad init` | Initialize Squad in current repo. `--global` for a personal squad. |
42
+ | `squad upgrade` | Update Squad-owned files. `--global`, `--migrate-directory` |
43
+ | `squad status` | Show which squad is active (repo vs personal) and why |
44
+ | `squad triage` | Scan for work and categorize issues |
45
+ | `squad loop` | Continuous work loop. `--filter <pattern>`, `--interval <seconds>` |
46
+ | `squad hire` | Team creation wizard. `--name <name>`, `--role <role>` |
47
+ | `squad copilot` | Add/remove @copilot coding agent. `--off`, `--auto-assign` |
48
+ | `squad plugin` | Manage plugin marketplaces (add/remove/list/browse) |
49
+ | `squad export` | Export squad to JSON snapshot. `--out <path>` |
50
+ | `squad import <file>` | Import squad from export file. `--force` to overwrite |
51
+ | `squad scrub-emails` | Remove email addresses from Squad state files |
52
+ | `squad help` | Show help |
53
+
54
+ ## Interactive Shell
55
+
56
+ Running `squad` with no arguments launches a REPL where you talk directly to your team.
57
+
58
+ - **Slash commands:** `/status`, `/history`, `/agents`, `/clear`, `/help`, `/quit`
59
+ - **@mentions:** Route messages to a specific agent (e.g. `@aria fix the login bug`)
60
+ - **Tab completion:** Agents and commands auto-complete
61
+
62
+ The shell coordinates work across agents, streams responses in real time, and keeps a session history.
63
+
64
+ ## Requirements
65
+
66
+ - **Node.js ≥ 20**
67
+ - **GitHub CLI** (`gh`) — required for issue/PR operations and the work loop
68
+ - **GitHub Copilot** — provides the AI backend for agent orchestration
69
+
70
+ ## Links
71
+
72
+ - **SDK:** [@bradygaster/squad-sdk](https://www.npmjs.com/package/@bradygaster/squad-sdk)
73
+ - **Issues:** [github.com/bradygaster/squad-pr/issues](https://github.com/bradygaster/squad-pr/issues)
74
+
75
+ ## License
76
+
77
+ See [LICENSE](https://github.com/bradygaster/squad-pr/blob/main/LICENSE) in the repository root.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bradygaster/squad-cli",
3
- "version": "0.6.0",
3
+ "version": "0.6.2",
4
4
  "description": "Squad CLI — Command-line interface for the Squad multi-agent runtime",
5
5
  "type": "module",
6
6
  "bin": {
@@ -17,7 +17,7 @@
17
17
  "node": ">=20"
18
18
  },
19
19
  "dependencies": {
20
- "@bradygaster/squad-sdk": "0.6.0"
20
+ "@bradygaster/squad-sdk": "0.6.2"
21
21
  },
22
22
  "keywords": [
23
23
  "copilot",