@braingrid/cli 0.2.7 → 0.2.9
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/CHANGELOG.md +34 -0
- package/README.md +15 -65
- package/dist/cli.js +13 -9
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,40 @@ All notable changes to this project will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [0.2.9] - 2025-11-12
|
|
9
|
+
|
|
10
|
+
### Fixed
|
|
11
|
+
|
|
12
|
+
- **Documentation URLs updated to docs subdomain**
|
|
13
|
+
- Updated Claude Code documentation URL from `https://braingrid.ai/docs/claude-code` to `https://docs.braingrid.ai/claude-code`
|
|
14
|
+
- Updated Cursor documentation URL from `https://braingrid.ai/docs/cursor` to `https://docs.braingrid.ai/cursor`
|
|
15
|
+
- URLs displayed in setup command success messages now point to correct documentation location
|
|
16
|
+
- Affects `braingrid setup claude-code` and `braingrid setup cursor` output
|
|
17
|
+
|
|
18
|
+
## [0.2.8] - 2025-11-12
|
|
19
|
+
|
|
20
|
+
### Fixed
|
|
21
|
+
|
|
22
|
+
- **Recursive directory processing for setup commands**
|
|
23
|
+
- Fixed critical bug where nested directories weren't installed during `braingrid setup claude-code`
|
|
24
|
+
- Skills directory (`.claude/skills/braingrid-cli/`) now properly installed with all files
|
|
25
|
+
- Added recursive `processDirectory()` helper to traverse subdirectory structures
|
|
26
|
+
- Setup commands now correctly handle both files and nested directories from GitHub
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
|
|
30
|
+
- **Enhanced skill reference in CLAUDE.md**
|
|
31
|
+
- Expanded skill reference from 7 words to comprehensive 8-line section
|
|
32
|
+
- Added engaging question format: "Need help with planning or requirements?"
|
|
33
|
+
- Listed 5 specific benefits: guided workflows, best practices, proactive suggestions, examples, installation help
|
|
34
|
+
- Added CLAUDE.md to sync script for distribution to users
|
|
35
|
+
- Improves skill discoverability in Claude Code
|
|
36
|
+
|
|
37
|
+
- **Documentation improvements**
|
|
38
|
+
- Removed deprecated `--verbose` flag references from all documentation
|
|
39
|
+
- Added full CLI command reference to skill documentation
|
|
40
|
+
- Updated project configuration with organization UUID
|
|
41
|
+
|
|
8
42
|
## [0.2.7] - 2025-11-11
|
|
9
43
|
|
|
10
44
|
### Fixed
|
package/README.md
CHANGED
|
@@ -37,77 +37,27 @@ npm install -g @braingrid/cli
|
|
|
37
37
|
|
|
38
38
|
---
|
|
39
39
|
|
|
40
|
-
##
|
|
40
|
+
## IDE Integration
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
### What is AGENTS.md?
|
|
45
|
-
|
|
46
|
-
[AGENTS.md](https://agents.md/) is an open standard that allows AI coding assistants to automatically load project-specific guidance and commands. BrainGrid uses this standard to provide consistent CLI guidance across multiple tools:
|
|
47
|
-
|
|
48
|
-
- ✅ **Cursor IDE** - Automatic loading via AGENTS.md + slash commands
|
|
49
|
-
- ✅ **Claude Code** - Automatic loading via AGENTS.md or .claude/CLAUDE.md
|
|
50
|
-
- ✅ **GitHub Copilot** - Context from AGENTS.md
|
|
51
|
-
- ✅ **Growing ecosystem** of AGENTS.md-compatible tools
|
|
52
|
-
|
|
53
|
-
### Setup for Cursor IDE
|
|
54
|
-
|
|
55
|
-
**Prerequisites:**
|
|
56
|
-
|
|
57
|
-
- Cursor IDE installed ([download here](https://cursor.sh/))
|
|
58
|
-
- BrainGrid CLI installed and authenticated
|
|
59
|
-
|
|
60
|
-
**How it works:**
|
|
61
|
-
|
|
62
|
-
1. **AGENTS.md** at your repository root is automatically loaded by Cursor
|
|
63
|
-
2. **.cursor/rules/braingrid.mdc** provides Cursor-specific enhancements (always-on rules)
|
|
64
|
-
3. **Slash commands** available via `/` in Cursor's Agent input
|
|
65
|
-
|
|
66
|
-
**Available Commands:**
|
|
67
|
-
|
|
68
|
-
Type `/` in Cursor's Agent input to access:
|
|
69
|
-
|
|
70
|
-
- `/specify` - Create AI-refined requirements from natural language
|
|
71
|
-
- `/breakdown` - Break requirements into implementation tasks
|
|
72
|
-
- `/save-requirement` - Save requirement content to BrainGrid
|
|
73
|
-
- `/build` - Generate complete implementation plan
|
|
74
|
-
|
|
75
|
-
**Quick Start Example:**
|
|
42
|
+
### Claude Code
|
|
76
43
|
|
|
77
44
|
```bash
|
|
78
|
-
|
|
79
|
-
/specify "Add user authentication with OAuth2"
|
|
80
|
-
# → Creates REQ-123
|
|
81
|
-
|
|
82
|
-
/breakdown REQ-123
|
|
83
|
-
# → Generates 5-10 implementation tasks
|
|
84
|
-
|
|
85
|
-
/build REQ-123
|
|
86
|
-
# → Shows complete requirement with all task prompts
|
|
45
|
+
braingrid setup claude-code
|
|
87
46
|
```
|
|
88
47
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
BrainGrid's AGENTS.md file also works with Claude Code. You can either:
|
|
92
|
-
|
|
93
|
-
1. **Use AGENTS.md directly** (Claude Code automatically reads it)
|
|
94
|
-
2. **Symlink for compatibility**: `ln -s AGENTS.md .claude/CLAUDE.md`
|
|
95
|
-
|
|
96
|
-
Claude Code also provides its own slash commands in `.claude/commands/`.
|
|
48
|
+
Installs slash commands (`/specify`, `/breakdown`, `/build`), BrainGrid skill, and status line showing your project/requirement/task context in real-time.
|
|
97
49
|
|
|
98
|
-
|
|
50
|
+
[→ Full Claude Code setup guide](./.claude/README.md)
|
|
99
51
|
|
|
100
|
-
|
|
52
|
+
### Cursor
|
|
101
53
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
54
|
+
```bash
|
|
55
|
+
braingrid setup cursor
|
|
56
|
+
```
|
|
105
57
|
|
|
106
|
-
|
|
58
|
+
Installs slash commands, always-on rules, and AGENTS.md integration for seamless BrainGrid workflows in Agent mode.
|
|
107
59
|
|
|
108
|
-
|
|
109
|
-
- [BrainGrid documentation](https://www.braingrid.ai)
|
|
110
|
-
- Full CLI command reference in [AGENTS.md](./AGENTS.md)
|
|
60
|
+
[→ Full Cursor setup guide](./.cursor/README.md)
|
|
111
61
|
|
|
112
62
|
---
|
|
113
63
|
|
|
@@ -165,6 +115,8 @@ The `init` command creates a `.braingrid/project.json` file in the `.braingrid/`
|
|
|
165
115
|
|
|
166
116
|
Install BrainGrid integration files for AI coding tools. These commands fetch integration files from the [BrainGrid repository](https://github.com/BrainGridAI/braingrid) and install them in your project.
|
|
167
117
|
|
|
118
|
+
For detailed usage guides, see [Claude Code setup](./.claude/README.md) or [Cursor setup](./.cursor/README.md).
|
|
119
|
+
|
|
168
120
|
**Prerequisites:**
|
|
169
121
|
|
|
170
122
|
- **GitHub CLI** must be installed and authenticated
|
|
@@ -259,7 +211,7 @@ braingrid requirement create --name "Name" [--content "Description"] [--assigned
|
|
|
259
211
|
braingrid requirement show [id]
|
|
260
212
|
braingrid requirement update [id] [--status IDEA|PLANNED|IN_PROGRESS|REVIEW|COMPLETED|CANCELLED] [--name "New Name"]
|
|
261
213
|
braingrid requirement delete [id] [--force]
|
|
262
|
-
braingrid requirement breakdown [id]
|
|
214
|
+
braingrid requirement breakdown [id]
|
|
263
215
|
braingrid requirement build [id] [--format markdown|json|xml]
|
|
264
216
|
|
|
265
217
|
# Working with a different project:
|
|
@@ -279,7 +231,7 @@ braingrid requirement create -p PROJ-456 --name "Description"
|
|
|
279
231
|
|
|
280
232
|
```bash
|
|
281
233
|
# Working with the initialized project
|
|
282
|
-
braingrid task list -r REQ-456 [--format table|json|xml|markdown]
|
|
234
|
+
braingrid task list -r REQ-456 [--format table|json|xml|markdown]
|
|
283
235
|
braingrid task create -r REQ-456 --title "Task Title" [--content "Description"]
|
|
284
236
|
braingrid task show <id>
|
|
285
237
|
braingrid task update <id> [--status PLANNED|IN_PROGRESS|COMPLETED|CANCELLED] [--title "New Title"]
|
|
@@ -294,8 +246,6 @@ braingrid task create -p PROJ-123 -r REQ-456 --title "Task Title"
|
|
|
294
246
|
>
|
|
295
247
|
> **Note:** The `-r`/`--requirement` parameter is optional and accepts formats like `REQ-456`, `req-456`, or `456`. The CLI will automatically detect the requirement ID from your git branch name (e.g., `feature/REQ-123-description` or `REQ-123-fix-bug`) if it is not provided.
|
|
296
248
|
>
|
|
297
|
-
> **Note:** Use `--verbose` with `task list` to show full task content in addition to task metadata.
|
|
298
|
-
>
|
|
299
249
|
> **Note:** Task status values are: `PLANNED`, `IN_PROGRESS`, `COMPLETED`, `CANCELLED` (tasks do not have `IDEA` or `REVIEW` status).
|
|
300
250
|
|
|
301
251
|
### Informational Commands
|
package/dist/cli.js
CHANGED
|
@@ -422,7 +422,7 @@ import axios3, { AxiosError as AxiosError2 } from "axios";
|
|
|
422
422
|
|
|
423
423
|
// src/build-config.ts
|
|
424
424
|
var BUILD_ENV = true ? "production" : process.env.NODE_ENV === "test" ? "development" : "production";
|
|
425
|
-
var CLI_VERSION = true ? "0.2.
|
|
425
|
+
var CLI_VERSION = true ? "0.2.9" : "0.0.0-test";
|
|
426
426
|
var PRODUCTION_CONFIG = {
|
|
427
427
|
apiUrl: "https://app.braingrid.ai",
|
|
428
428
|
workosAuthUrl: "https://sensitive-harvest-60.authkit.app",
|
|
@@ -5589,14 +5589,12 @@ async function checkPrerequisites() {
|
|
|
5589
5589
|
}
|
|
5590
5590
|
async function getFileList(sourcePaths, targetPaths) {
|
|
5591
5591
|
const operations = [];
|
|
5592
|
-
|
|
5593
|
-
const sourcePath = sourcePaths[i];
|
|
5594
|
-
const targetPath = targetPaths[i];
|
|
5592
|
+
async function processDirectory(sourceDir, targetDir) {
|
|
5595
5593
|
try {
|
|
5596
|
-
const items = await listGitHubDirectory(
|
|
5594
|
+
const items = await listGitHubDirectory(sourceDir);
|
|
5597
5595
|
for (const item of items) {
|
|
5598
5596
|
if (item.type === "file") {
|
|
5599
|
-
const itemTargetPath = path4.join(
|
|
5597
|
+
const itemTargetPath = path4.join(targetDir, item.name);
|
|
5600
5598
|
const exists = await fileExists(itemTargetPath);
|
|
5601
5599
|
operations.push({
|
|
5602
5600
|
type: "copy",
|
|
@@ -5604,15 +5602,21 @@ async function getFileList(sourcePaths, targetPaths) {
|
|
|
5604
5602
|
targetPath: itemTargetPath,
|
|
5605
5603
|
exists
|
|
5606
5604
|
});
|
|
5605
|
+
} else if (item.type === "dir") {
|
|
5606
|
+
const itemTargetPath = path4.join(targetDir, item.name);
|
|
5607
|
+
await processDirectory(item.path, itemTargetPath);
|
|
5607
5608
|
}
|
|
5608
5609
|
}
|
|
5609
5610
|
} catch (error) {
|
|
5610
5611
|
console.warn(
|
|
5611
|
-
chalk12.yellow(`\u26A0\uFE0F Could not list directory: ${
|
|
5612
|
+
chalk12.yellow(`\u26A0\uFE0F Could not list directory: ${sourceDir}`),
|
|
5612
5613
|
error instanceof Error ? error.message : String(error)
|
|
5613
5614
|
);
|
|
5614
5615
|
}
|
|
5615
5616
|
}
|
|
5617
|
+
for (let i = 0; i < sourcePaths.length; i++) {
|
|
5618
|
+
await processDirectory(sourcePaths[i], targetPaths[i]);
|
|
5619
|
+
}
|
|
5616
5620
|
return operations;
|
|
5617
5621
|
}
|
|
5618
5622
|
function displayInstallationPlan(operations, injectionFile) {
|
|
@@ -5762,7 +5766,7 @@ async function handleSetupClaudeCode(opts) {
|
|
|
5762
5766
|
sourceFile: "claude-code/CLAUDE.md",
|
|
5763
5767
|
targetFile: "CLAUDE.md"
|
|
5764
5768
|
},
|
|
5765
|
-
docsUrl: "https://braingrid.ai/
|
|
5769
|
+
docsUrl: "https://docs.braingrid.ai/claude-code"
|
|
5766
5770
|
};
|
|
5767
5771
|
return _handleSetup(config, opts);
|
|
5768
5772
|
}
|
|
@@ -5775,7 +5779,7 @@ async function handleSetupCursor(opts) {
|
|
|
5775
5779
|
sourceFile: "cursor/AGENTS.md",
|
|
5776
5780
|
targetFile: "AGENTS.md"
|
|
5777
5781
|
},
|
|
5778
|
-
docsUrl: "https://braingrid.ai/
|
|
5782
|
+
docsUrl: "https://docs.braingrid.ai/cursor"
|
|
5779
5783
|
};
|
|
5780
5784
|
return _handleSetup(config, opts);
|
|
5781
5785
|
}
|