byterover-cli 0.1.1 → 0.2.0

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 (44) hide show
  1. package/README.md +37 -27
  2. package/bin/dev.cmd +1 -1
  3. package/bin/dev.js +1 -1
  4. package/bin/run.cmd +1 -1
  5. package/bin/run.js +1 -1
  6. package/dist/commands/add.js +1 -1
  7. package/dist/commands/init.js +13 -8
  8. package/dist/commands/push.d.ts +5 -5
  9. package/dist/commands/push.js +11 -11
  10. package/dist/commands/retrieve.d.ts +2 -2
  11. package/dist/commands/retrieve.js +3 -3
  12. package/dist/commands/space/list.js +10 -5
  13. package/dist/commands/space/switch.js +8 -7
  14. package/dist/commands/status.js +5 -5
  15. package/dist/config/environment.d.ts +3 -2
  16. package/dist/config/environment.js +5 -3
  17. package/dist/constants.d.ts +8 -1
  18. package/dist/constants.js +8 -1
  19. package/dist/core/domain/entities/{br-config.d.ts → brv-config.d.ts} +5 -5
  20. package/dist/core/domain/entities/{br-config.js → brv-config.js} +5 -5
  21. package/dist/core/interfaces/i-playbook-service.d.ts +1 -1
  22. package/dist/core/interfaces/i-project-config-store.d.ts +10 -10
  23. package/dist/hooks/init/welcome.d.ts +3 -0
  24. package/dist/hooks/init/welcome.js +31 -0
  25. package/dist/infra/ace/ace-file-utils.js +2 -2
  26. package/dist/infra/ace/file-bullet-content-store.d.ts +4 -4
  27. package/dist/infra/ace/file-bullet-content-store.js +7 -7
  28. package/dist/infra/ace/file-delta-store.d.ts +1 -1
  29. package/dist/infra/ace/file-delta-store.js +1 -1
  30. package/dist/infra/ace/file-executor-output-store.d.ts +1 -1
  31. package/dist/infra/ace/file-executor-output-store.js +1 -1
  32. package/dist/infra/ace/file-playbook-store.d.ts +3 -3
  33. package/dist/infra/ace/file-playbook-store.js +6 -6
  34. package/dist/infra/ace/file-reflection-store.d.ts +1 -1
  35. package/dist/infra/ace/file-reflection-store.js +1 -1
  36. package/dist/infra/config/file-config-store.d.ts +6 -8
  37. package/dist/infra/config/file-config-store.js +10 -11
  38. package/dist/infra/playbook/file-playbook-service.d.ts +0 -1
  39. package/dist/infra/playbook/file-playbook-service.js +7 -8
  40. package/dist/templates/README.md +5 -5
  41. package/dist/templates/sections/command-reference.md +23 -23
  42. package/dist/templates/sections/workflow.md +3 -4
  43. package/oclif.manifest.json +3 -3
  44. package/package.json +7 -4
@@ -2,7 +2,7 @@
2
2
 
3
3
  ## Memory Commands
4
4
 
5
- ### `br add`
5
+ ### `brv add`
6
6
 
7
7
  **Description:** Add or update a bullet in the playbook (bypasses ACE workflow for direct agent usage)
8
8
 
@@ -15,9 +15,9 @@
15
15
  **Examples:**
16
16
 
17
17
  ```bash
18
- br add --section "Common Errors" --content "Authentication fails when token expires"
19
- br add --section "Common Errors" --bullet-id "common-00001" --content "Updated: Auth fails when token expires"
20
- br add -s "Best Practices" -c "Always validate user input before processing"
18
+ brv add --section "Common Errors" --content "Authentication fails when token expires"
19
+ brv add --section "Common Errors" --bullet-id "common-00001" --content "Updated: Auth fails when token expires"
20
+ brv add -s "Best Practices" -c "Always validate user input before processing"
21
21
  ```
22
22
 
23
23
  **Suggested Sections:** Common Errors, Best Practices, Strategies, Lessons Learned, Project Structure and Dependencies, Testing, Code Style and Quality, Styling and Design
@@ -29,11 +29,11 @@ br add -s "Best Practices" -c "Always validate user input before processing"
29
29
  - Updates existing bullet if `--bullet-id` matches existing bullet
30
30
  - Displays bullet ID, section, content, and tags after operation
31
31
 
32
- **Requirements:** Playbook must exist (run `br init` first)
32
+ **Requirements:** Playbook must exist (run `brv init` first)
33
33
 
34
34
  ---
35
35
 
36
- ### `br retrieve`
36
+ ### `brv retrieve`
37
37
 
38
38
  **Description:** Retrieve memories from ByteRover Memora service and save to local ACE playbook
39
39
 
@@ -45,9 +45,9 @@ br add -s "Best Practices" -c "Always validate user input before processing"
45
45
  **Examples:**
46
46
 
47
47
  ```bash
48
- br retrieve --query "authentication best practices"
49
- br retrieve -q "error handling" -n "src/auth/login.ts,src/auth/oauth.ts"
50
- br retrieve -q "database connection issues"
48
+ brv retrieve --query "authentication best practices"
49
+ brv retrieve -q "error handling" -n "src/auth/login.ts,src/auth/oauth.ts"
50
+ brv retrieve -q "database connection issues"
51
51
  ```
52
52
 
53
53
  **Behavior:**
@@ -65,7 +65,7 @@ br retrieve -q "database connection issues"
65
65
 
66
66
  ---
67
67
 
68
- ### `br push`
68
+ ### `brv push`
69
69
 
70
70
  **Description:** Push playbook to ByteRover memory storage and clean up local ACE files
71
71
 
@@ -76,13 +76,13 @@ br retrieve -q "database connection issues"
76
76
  **Examples:**
77
77
 
78
78
  ```bash
79
- br push
80
- br push --branch develop
79
+ brv push
80
+ brv push --branch develop
81
81
  ```
82
82
 
83
83
  ---
84
84
 
85
- ### `br complete`
85
+ ### `brv complete`
86
86
 
87
87
  **Description:** Complete ACE workflow: save executor output, generate reflection, and update playbook in one command
88
88
 
@@ -102,9 +102,9 @@ br push --branch develop
102
102
  **Examples:**
103
103
 
104
104
  ```bash
105
- br complete "user-auth" "Implemented OAuth2 flow" "Auth works" --tool-usage "Read:src/auth.ts,Edit:src/auth.ts,Bash:npm test" --feedback "All tests passed"
106
- br complete "validation-fix" "Analyzed validator" "Fixed bug" --tool-usage "Grep:pattern:\"validate\",Read:src/validator.ts" --bullet-ids "bullet-123" --feedback "Tests passed"
107
- br complete "auth-update" "Improved error handling" "Better errors" --tool-usage "Edit:src/auth.ts" --feedback "Tests passed" --update-bullet "bullet-5"
105
+ brv complete "user-auth" "Implemented OAuth2 flow" "Auth works" --tool-usage "Read:src/auth.ts,Edit:src/auth.ts,Bash:npm test" --feedback "All tests passed"
106
+ brv complete "validation-fix" "Analyzed validator" "Fixed bug" --tool-usage "Grep:pattern:\"validate\",Read:src/validator.ts" --bullet-ids "bullet-123" --feedback "Tests passed"
107
+ brv complete "auth-update" "Improved error handling" "Better errors" --tool-usage "Edit:src/auth.ts" --feedback "Tests passed" --update-bullet "bullet-5"
108
108
  ```
109
109
 
110
110
  **Behavior:**
@@ -120,22 +120,22 @@ br complete "auth-update" "Improved error handling" "Better errors" --tool-usage
120
120
 
121
121
  ---
122
122
 
123
- ### `br show`
123
+ ### `brv show`
124
124
 
125
125
  ## Best Practices
126
126
 
127
127
  ### Efficient Workflow
128
128
 
129
- 1. **Retrieve wisely:** Use `br retrieve` with specific queries and `--node-keys` to filter
130
- 2. **Read only what's needed:** Check playbook with `br status` to see statistics before reading full content
131
- 3. **Update precisely:** Use `br add` to add/update specific bullets or `br complete` for complete workflow
132
- 4. **Push when appropriate:** Prompt user to run `br push` after completing significant work
129
+ 1. **Retrieve wisely:** Use `brv retrieve` with specific queries and `--node-keys` to filter
130
+ 2. **Read only what's needed:** Check playbook with `brv status` to see statistics before reading full content
131
+ 3. **Update precisely:** Use `brv add` to add/update specific bullets or `brv complete` for complete workflow
132
+ 4. **Push when appropriate:** Prompt user to run `brv push` after completing significant work
133
133
 
134
134
  ### Memory Management
135
135
 
136
136
  **Retrieve pattern:**
137
137
 
138
- - Use `br add` to directly add/update bullets
139
- - `br retrieve` **clears existing playbook** - use carefully
138
+ - Use `brv add` to directly add/update bullets
139
+ - `brv retrieve` **clears existing playbook** - use carefully
140
140
  - Retrieved memories use actual Memora tags (not "auto-generated")
141
141
  - Both memories and related memories are saved to playbook
@@ -1,6 +1,6 @@
1
1
  # Workflow Instruction
2
2
 
3
- You are a coding agent focused on one codebase. Use the br CLI to manage working context.
3
+ You are a coding agent focused on one codebase. Use the brv CLI to manage working context.
4
4
  Core Rules:
5
5
 
6
6
  - Start from memory. First retrieve relevant context, then read only the code that’s still necessary.
@@ -8,15 +8,14 @@ Core Rules:
8
8
 
9
9
  ## user-centric
10
10
 
11
- Before running any `br` command, ask the user to choose:
11
+ Before running any `brv` command, ask the user to choose:
12
12
 
13
13
  1. **Accept** - Review the command, then run if approved
14
14
  2. **Auto-run** - Execute immediately (remember this preference for the session)
15
15
  3. **No** - Cancel the command and continue without alternative
16
16
  4. **Custom** - Skip the command and provide different instruction
17
17
 
18
- Once the user chooses "Auto-run", apply that preference to all subsequent `br` commands in this conversation without asking again.
19
-
18
+ Once the user chooses "Auto-run", apply that preference to all subsequent `brv` commands in this conversation without asking again.
20
19
 
21
20
  ## Daily Flow
22
21
 
@@ -204,7 +204,7 @@
204
204
  "init": {
205
205
  "aliases": [],
206
206
  "args": {},
207
- "description": "Initialize a project with ByteRover (creates .br/config.json with team/space selection and initializes ACE playbook)",
207
+ "description": "Initialize a project with ByteRover (creates .brv/config.json with team/space selection and initializes ACE playbook)",
208
208
  "examples": [
209
209
  "<%= config.bin %> <%= command.id %>",
210
210
  "# Re-initialize if config exists (will show current config and exit):\n<%= config.bin %> <%= command.id %>",
@@ -456,7 +456,7 @@
456
456
  "space:switch": {
457
457
  "aliases": [],
458
458
  "args": {},
459
- "description": "Switch to a different team or space (updates .br/config.json)",
459
+ "description": "Switch to a different team or space (updates .brv/config.json)",
460
460
  "examples": [
461
461
  "<%= config.bin %> <%= command.id %>",
462
462
  "# Shows current configuration, then prompts for new team/space selection"
@@ -479,5 +479,5 @@
479
479
  ]
480
480
  }
481
481
  },
482
- "version": "0.1.1"
482
+ "version": "0.2.0"
483
483
  }
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "byterover-cli",
3
3
  "description": "ByteRover's CLI",
4
- "version": "0.1.1",
4
+ "version": "0.2.0",
5
5
  "author": "ByteRover",
6
6
  "bin": {
7
- "br": "./bin/run.js"
7
+ "brv": "./bin/run.js"
8
8
  },
9
9
  "bugs": "https://github.com/campfirein/byterover-cli/issues",
10
10
  "dependencies": {
@@ -55,9 +55,12 @@
55
55
  "main": "dist/index.js",
56
56
  "type": "module",
57
57
  "oclif": {
58
- "bin": "br",
59
- "dirname": "br",
58
+ "bin": "brv",
59
+ "dirname": "brv",
60
60
  "commands": "./dist/commands",
61
+ "hooks": {
62
+ "init": "./dist/hooks/init/welcome"
63
+ },
61
64
  "plugins": [
62
65
  "@oclif/plugin-help"
63
66
  ],