@bradygaster/squad-sdk 0.6.0 → 0.6.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.
- package/README.md +38 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @bradygaster/squad-sdk
|
|
2
2
|
|
|
3
|
-
Programmable multi-agent runtime for GitHub Copilot,
|
|
3
|
+
Programmable multi-agent runtime for GitHub Copilot. Resolves squad configuration, loads agent teams, and manages the SDK lifecycle.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -8,10 +8,43 @@ Programmable multi-agent runtime for GitHub Copilot, built on `@github/copilot-s
|
|
|
8
8
|
npm install @bradygaster/squad-sdk
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Quick Example
|
|
12
12
|
|
|
13
|
-
```
|
|
14
|
-
import { loadConfig } from '@bradygaster/squad-sdk';
|
|
13
|
+
```typescript
|
|
14
|
+
import { resolveSquad, loadConfig } from '@bradygaster/squad-sdk';
|
|
15
|
+
|
|
16
|
+
// Find the .squad/ directory by walking up from cwd
|
|
17
|
+
const squadDir = await resolveSquad();
|
|
18
|
+
|
|
19
|
+
// Load squad configuration
|
|
20
|
+
const config = await loadConfig();
|
|
21
|
+
|
|
22
|
+
console.log('Loaded team:', config.team.name);
|
|
15
23
|
```
|
|
16
24
|
|
|
17
|
-
|
|
25
|
+
## API Overview
|
|
26
|
+
|
|
27
|
+
| Module | Key Exports | Purpose |
|
|
28
|
+
|--------|------------|---------|
|
|
29
|
+
| `resolution` | `resolveSquad()`, `resolveGlobalSquadPath()`, `ensureSquadPath()` | Walk-up to find `.squad/` directory; platform-specific global squad path; validate paths stay inside `.squad/` |
|
|
30
|
+
| `config` | `loadConfig()`, `loadConfigSync()` | Load and parse squad configuration from disk |
|
|
31
|
+
| `agents` | Agent onboarding utilities | Register and initialize agents; manage team discovery |
|
|
32
|
+
| `casting` | Casting engine | Universe selection, name allocation, registry management |
|
|
33
|
+
| `skills` | Skills system | Load SKILL.md lifecycle, manage confidence levels |
|
|
34
|
+
| `coordinator` | `selectResponseTier()`, `getTier()` | Route requests to Direct/Lightweight/Standard/Full tiers |
|
|
35
|
+
| `runtime` | Streaming pipeline, cost tracker, telemetry, offline mode | Core async execution, event streaming, i18n support |
|
|
36
|
+
| `cli` | `checkForUpdate()`, `performUpgrade()` | SDK version management and update checking |
|
|
37
|
+
| `cli` | Output helpers, GitHub utilities | `success()`, `error()`, `warn()`, `info()`, GitHub issue management |
|
|
38
|
+
| `marketplace` | Plugin marketplace management | Discover and manage plugins |
|
|
39
|
+
|
|
40
|
+
## Requirements
|
|
41
|
+
|
|
42
|
+
- **Node.js:** ≥20
|
|
43
|
+
- **TypeScript:** ≥5.0 (for type definitions)
|
|
44
|
+
- **Module system:** ESM-only (no CommonJS)
|
|
45
|
+
|
|
46
|
+
## Links
|
|
47
|
+
|
|
48
|
+
- **Repository:** [github.com/bradygaster/squad-pr](https://github.com/bradygaster/squad-pr)
|
|
49
|
+
- **Issues:** [github.com/bradygaster/squad-pr/issues](https://github.com/bradygaster/squad-pr/issues)
|
|
50
|
+
- **Main README:** [github.com/bradygaster/squad-pr#readme](https://github.com/bradygaster/squad-pr#readme)
|