@braid-cloud/cli 0.1.5 → 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 +119 -19
- package/dist/index.js +1679 -401
- 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,24 @@ 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.
|
|
35
|
+
|
|
36
|
+
During login, the CLI now walks you through:
|
|
37
|
+
|
|
38
|
+
1. Signing in with your API key
|
|
39
|
+
2. Launching an interactive scope wizard
|
|
40
|
+
3. Selecting organization/profile/projects with name + ID context
|
|
41
|
+
|
|
42
|
+
Scope defaults are saved to `braid.user.json` so `braid install` can run without repeatedly passing context flags.
|
|
30
43
|
|
|
31
44
|
```bash
|
|
32
45
|
braid auth # Interactive login (alias for `braid auth login`)
|
|
@@ -34,11 +47,13 @@ braid auth status # Check auth status
|
|
|
34
47
|
braid auth logout # Remove stored credentials
|
|
35
48
|
```
|
|
36
49
|
|
|
50
|
+
After a successful login, `braid auth` offers to run `braid scope --file user` so you can pick your defaults from live org/project/profile data.
|
|
51
|
+
|
|
37
52
|
The `login` subcommand accepts:
|
|
38
53
|
|
|
39
54
|
| Flag | Description |
|
|
40
55
|
| -------------------- | --------------------------------------------- |
|
|
41
|
-
| `-s, --server <url>` |
|
|
56
|
+
| `-s, --server <url>` | braid server URL (for review apps, local dev) |
|
|
42
57
|
|
|
43
58
|
### `braid install`
|
|
44
59
|
|
|
@@ -96,6 +111,33 @@ braid list # Project-local skills
|
|
|
96
111
|
braid list --global # Global skills only
|
|
97
112
|
```
|
|
98
113
|
|
|
114
|
+
### `braid scope`
|
|
115
|
+
|
|
116
|
+
Interactively choose scope and write either `braid.user.json` or `braid.json`.
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
braid scope # Prompt for target file + scope choices
|
|
120
|
+
braid scope --file user # Force write to braid.user.json
|
|
121
|
+
braid scope --file project # Force write to braid.json
|
|
122
|
+
braid scope --server http://localhost:3211
|
|
123
|
+
|
|
124
|
+
# Non-interactive (script-friendly)
|
|
125
|
+
braid scope --file user --organization personal --source profile --profile default
|
|
126
|
+
braid scope --file project --organization organization --source manual --projects proj_a,proj_b --include-org-global
|
|
127
|
+
braid scope --file user --organization personal --source manual --projects proj_a --rule-ids rule_1,rule_2
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
Wizard flow:
|
|
131
|
+
|
|
132
|
+
1. Choose config target (`braid.user.json` or `braid.json`)
|
|
133
|
+
2. Choose organization context (personal or organization)
|
|
134
|
+
3. Choose source (`profile` or `manual`)
|
|
135
|
+
4. In manual mode: choose global toggles, optional project scopes, optional rule include/exclude filters
|
|
136
|
+
5. Select profile/projects/rules by name (with ID hints)
|
|
137
|
+
|
|
138
|
+
Manual mode supports combining global + project scopes together (not either/or).
|
|
139
|
+
When you belong to multiple orgs, the wizard lets you pick which org's projects to browse.
|
|
140
|
+
|
|
99
141
|
### `braid update`
|
|
100
142
|
|
|
101
143
|
Update installed skills to latest versions. Alias: `braid up`
|
|
@@ -117,6 +159,41 @@ braid remove --all # Remove all skills
|
|
|
117
159
|
braid remove --global # Global only
|
|
118
160
|
```
|
|
119
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
|
+
|
|
120
197
|
## Configuration
|
|
121
198
|
|
|
122
199
|
### Token Resolution
|
|
@@ -147,26 +224,33 @@ For teams, use two config files in your project root:
|
|
|
147
224
|
|
|
148
225
|
```json
|
|
149
226
|
{
|
|
150
|
-
"token": "br_your_personal_token"
|
|
227
|
+
"token": "br_your_personal_token",
|
|
228
|
+
"profile": "coding-standards"
|
|
151
229
|
}
|
|
152
230
|
```
|
|
153
231
|
|
|
154
232
|
This lets teams share configuration while each developer uses their own token.
|
|
233
|
+
`braid auth` can create/update this file for you through its onboarding wizard.
|
|
155
234
|
|
|
156
235
|
### All Config Options
|
|
157
236
|
|
|
158
237
|
Both `braid.json` and `braid.user.json` support these fields. Values in `braid.user.json` override `braid.json`.
|
|
159
238
|
|
|
160
|
-
| Field | Type | Description
|
|
161
|
-
| ------------------- | -------- |
|
|
162
|
-
| `token` | string | Personal Access Token
|
|
163
|
-
| `serverUrl` | string | Server URL (default: `https://braid.cloud`)
|
|
164
|
-
| `
|
|
165
|
-
| `
|
|
166
|
-
| `
|
|
167
|
-
| `
|
|
168
|
-
| `
|
|
169
|
-
| `
|
|
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 |
|
|
170
254
|
|
|
171
255
|
### Environment Variables
|
|
172
256
|
|
|
@@ -194,7 +278,7 @@ Skills are installed to agent-specific directories. The CLI auto-detects install
|
|
|
194
278
|
| Roo Code | `.roo/skills/` | `~/.roo/skills/` |
|
|
195
279
|
|
|
196
280
|
<details>
|
|
197
|
-
<summary>All
|
|
281
|
+
<summary>All supported agents</summary>
|
|
198
282
|
|
|
199
283
|
| Agent | Project Path | Global Path |
|
|
200
284
|
| ------------- | ---------------------- | -------------------------------------- |
|
|
@@ -239,6 +323,22 @@ Some agents also receive rules (always-on standards) in addition to skills. The
|
|
|
239
323
|
| Cline | Appended | `.clinerules` |
|
|
240
324
|
| Windsurf | Appended | `.windsurfrules` |
|
|
241
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
|
+
|
|
242
342
|
## Skill Format
|
|
243
343
|
|
|
244
344
|
Installed skills are directories with a `SKILL.md` file:
|
|
@@ -278,8 +378,8 @@ Installed skills are tracked in `.braidskills-metadata.json` for update detectio
|
|
|
278
378
|
## Related
|
|
279
379
|
|
|
280
380
|
- **[@braid-cloud/mcp](https://www.npmjs.com/package/@braid-cloud/mcp)** - Real-time MCP integration (no local files)
|
|
281
|
-
- **[
|
|
282
|
-
|
|
381
|
+
- **[braid Website](https://braid.cloud)** - Learn more about braid and sign up for an account.
|
|
382
|
+
-
|
|
283
383
|
## License
|
|
284
384
|
|
|
285
|
-
Proprietary -
|
|
385
|
+
Proprietary - all rights reserved.
|