@braid-cloud/cli 0.1.6 → 0.1.8
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/LICENSE +2 -2
- package/README.md +79 -18
- package/dist/index.js +604 -85
- package/dist/index.js.map +1 -1
- package/package.json +4 -2
package/LICENSE
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
braid Proprietary License
|
|
2
2
|
Copyright (c) 2026 braid ai labs, LLC All rights reserved.
|
|
3
3
|
|
|
4
4
|
Permission is hereby granted to use this software for its intended purpose
|
|
5
|
-
(installing and managing
|
|
5
|
+
(installing and managing braid rules in your development environment).
|
|
6
6
|
|
|
7
7
|
You MAY NOT:
|
|
8
8
|
- Copy, reproduce, or redistribute the software or its source code
|
package/README.md
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
# @braid-cloud/cli
|
|
2
2
|
|
|
3
|
-
Install [
|
|
3
|
+
Install [braid](https://braid.cloud) prompts as local files for your AI coding agents, and configure braid MCP endpoints in supported tools.
|
|
4
4
|
|
|
5
5
|
## What It Does
|
|
6
6
|
|
|
7
|
-
Syncs your
|
|
7
|
+
Syncs your braid prompts to local files that AI coding agents automatically pick up. Works with 35+ agents including Claude Code, Cursor, GitHub Copilot, and more. Once installed, skills work offline.
|
|
8
|
+
|
|
9
|
+
Also configures braid MCP in supported tools by writing the right config entry format for each interface (for example standard JSON, typed stdio entries, Zed nested command blocks, and VS Code extension-specific MCP files).
|
|
8
10
|
|
|
9
11
|
## Quick Start
|
|
10
12
|
|
|
@@ -20,13 +22,16 @@ braid install --profile coding-standards
|
|
|
20
22
|
|
|
21
23
|
# View installed skills
|
|
22
24
|
braid list
|
|
25
|
+
|
|
26
|
+
# Configure MCP for a tool
|
|
27
|
+
braid mcp --tool claude-code --no-auth -y
|
|
23
28
|
```
|
|
24
29
|
|
|
25
30
|
## Commands
|
|
26
31
|
|
|
27
32
|
### `braid auth`
|
|
28
33
|
|
|
29
|
-
Authenticate with your
|
|
34
|
+
Authenticate with your braid account. Runs interactive login by default.
|
|
30
35
|
|
|
31
36
|
During login, the CLI now walks you through:
|
|
32
37
|
|
|
@@ -48,7 +53,7 @@ The `login` subcommand accepts:
|
|
|
48
53
|
|
|
49
54
|
| Flag | Description |
|
|
50
55
|
| -------------------- | --------------------------------------------- |
|
|
51
|
-
| `-s, --server <url>` |
|
|
56
|
+
| `-s, --server <url>` | braid server URL (for review apps, local dev) |
|
|
52
57
|
|
|
53
58
|
### `braid install`
|
|
54
59
|
|
|
@@ -154,6 +159,41 @@ braid remove --all # Remove all skills
|
|
|
154
159
|
braid remove --global # Global only
|
|
155
160
|
```
|
|
156
161
|
|
|
162
|
+
### `braid mcp`
|
|
163
|
+
|
|
164
|
+
Configure braid MCP entries in tool-specific MCP config files.
|
|
165
|
+
|
|
166
|
+
`braid mcp` supports:
|
|
167
|
+
|
|
168
|
+
- Adding/updating a braid MCP entry for a tool
|
|
169
|
+
- Removing only the braid MCP entry while preserving other MCP servers
|
|
170
|
+
- Status scanning across project/global MCP config locations
|
|
171
|
+
- Optional token embedding and custom MCP URL overrides
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
braid mcp # Interactive MCP setup
|
|
175
|
+
braid mcp --tool claude-code # Configure a specific tool
|
|
176
|
+
braid mcp --tool cursor --global # Write global config
|
|
177
|
+
braid mcp --tool claude-code --token br_xxx
|
|
178
|
+
braid mcp --tool claude-code --server https://custom.braid.cloud
|
|
179
|
+
braid mcp --status # Show configured tools
|
|
180
|
+
braid mcp --remove --tool claude-code # Remove braid MCP entry
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
**Options:**
|
|
184
|
+
|
|
185
|
+
| Flag | Description |
|
|
186
|
+
| -------------------- | ----------------------------------------- |
|
|
187
|
+
| `-t, --tool <name>` | Tool to configure |
|
|
188
|
+
| `-g, --global` | Use global config instead of project |
|
|
189
|
+
| `--token <token>` | Embed `BRAID_TOKEN` in MCP entry env |
|
|
190
|
+
| `--no-auth` | Skip token prompt / embedding |
|
|
191
|
+
| `--scope` | Run interactive scope wizard during setup |
|
|
192
|
+
| `--remove` | Remove braid MCP entry |
|
|
193
|
+
| `--status` | List tools currently configured for MCP |
|
|
194
|
+
| `-y, --yes` | Skip confirmation prompts |
|
|
195
|
+
| `-s, --server <url>` | Set `BRAID_MCP_URL` in MCP entry env |
|
|
196
|
+
|
|
157
197
|
## Configuration
|
|
158
198
|
|
|
159
199
|
### Token Resolution
|
|
@@ -196,16 +236,21 @@ This lets teams share configuration while each developer uses their own token.
|
|
|
196
236
|
|
|
197
237
|
Both `braid.json` and `braid.user.json` support these fields. Values in `braid.user.json` override `braid.json`.
|
|
198
238
|
|
|
199
|
-
| Field | Type | Description
|
|
200
|
-
| ------------------- | -------- |
|
|
201
|
-
| `token` | string | Personal Access Token
|
|
202
|
-
| `serverUrl` | string | Server URL (default: `https://braid.cloud`)
|
|
203
|
-
| `
|
|
204
|
-
| `
|
|
205
|
-
| `
|
|
206
|
-
| `
|
|
207
|
-
| `
|
|
208
|
-
| `
|
|
239
|
+
| Field | Type | Description |
|
|
240
|
+
| ------------------- | -------- | ----------------------------------------------------- |
|
|
241
|
+
| `token` | string | Personal Access Token |
|
|
242
|
+
| `serverUrl` | string | Server URL (default: `https://braid.cloud`) |
|
|
243
|
+
| `skills.serverUrl` | string | Skills endpoint override (alternative to `serverUrl`) |
|
|
244
|
+
| `org` | string | Default organization ID |
|
|
245
|
+
| `profile` | string | Default profile |
|
|
246
|
+
| `orgProjects` | string[] | Organization project IDs |
|
|
247
|
+
| `personalProjects` | string[] | Personal project IDs |
|
|
248
|
+
| `ruleIds` | string[] | Include only specific rule IDs |
|
|
249
|
+
| `excludedRuleIds` | string[] | Exclude specific rule IDs |
|
|
250
|
+
| `resolveOverlays` | boolean | Resolve overlay prompts from server |
|
|
251
|
+
| `includeUserGlobal` | boolean | Include user's global prompts (default: true) |
|
|
252
|
+
| `includeOrgGlobal` | boolean | Include org's global prompts (default: true) |
|
|
253
|
+
| `agents` | string[] | Target agents |
|
|
209
254
|
|
|
210
255
|
### Environment Variables
|
|
211
256
|
|
|
@@ -233,7 +278,7 @@ Skills are installed to agent-specific directories. The CLI auto-detects install
|
|
|
233
278
|
| Roo Code | `.roo/skills/` | `~/.roo/skills/` |
|
|
234
279
|
|
|
235
280
|
<details>
|
|
236
|
-
<summary>All
|
|
281
|
+
<summary>All supported agents</summary>
|
|
237
282
|
|
|
238
283
|
| Agent | Project Path | Global Path |
|
|
239
284
|
| ------------- | ---------------------- | -------------------------------------- |
|
|
@@ -278,6 +323,22 @@ Some agents also receive rules (always-on standards) in addition to skills. The
|
|
|
278
323
|
| Cline | Appended | `.clinerules` |
|
|
279
324
|
| Windsurf | Appended | `.windsurfrules` |
|
|
280
325
|
|
|
326
|
+
### MCP Support
|
|
327
|
+
|
|
328
|
+
Most supported tools now expose MCP config targets. `braid mcp` writes the braid entry to the correct root key and entry shape for each tool.
|
|
329
|
+
|
|
330
|
+
Common examples:
|
|
331
|
+
|
|
332
|
+
| Tool | Project Config | Global Config |
|
|
333
|
+
| -------------- | -------------------- | ------------------------------------------------------ |
|
|
334
|
+
| Claude Code | `.mcp.json` | — |
|
|
335
|
+
| Cursor | `.cursor/mcp.json` | `~/.cursor/mcp.json` |
|
|
336
|
+
| GitHub Copilot | `.vscode/mcp.json` | — |
|
|
337
|
+
| OpenCode | `.opencode/mcp.json` | `~/.config/opencode/mcp.json` |
|
|
338
|
+
| Cline | — | VS Code extension settings (`cline_mcp_settings.json`) |
|
|
339
|
+
| Roo Code | — | VS Code extension settings (`mcp_settings.json`) |
|
|
340
|
+
| Zed | — | `~/.config/zed/settings.json` |
|
|
341
|
+
|
|
281
342
|
## Skill Format
|
|
282
343
|
|
|
283
344
|
Installed skills are directories with a `SKILL.md` file:
|
|
@@ -317,8 +378,8 @@ Installed skills are tracked in `.braidskills-metadata.json` for update detectio
|
|
|
317
378
|
## Related
|
|
318
379
|
|
|
319
380
|
- **[@braid-cloud/mcp](https://www.npmjs.com/package/@braid-cloud/mcp)** - Real-time MCP integration (no local files)
|
|
320
|
-
- **[
|
|
321
|
-
|
|
381
|
+
- **[braid Website](https://braid.cloud)** - Learn more about braid and sign up for an account.
|
|
382
|
+
-
|
|
322
383
|
## License
|
|
323
384
|
|
|
324
|
-
Proprietary -
|
|
385
|
+
Proprietary - all rights reserved.
|