planexe-cli 0.0.5 → 0.0.7

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 (2) hide show
  1. package/README.md +16 -20
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,49 +1,49 @@
1
- # The most powerful coding agent
1
+ # PlanExe CLI AI-powered planning and coding agent
2
2
 
3
- Codebuff is a CLI tool that writes code for you.
3
+ PlanExe is a CLI tool that writes code and builds plans for you.
4
4
 
5
- 1. Run `codebuff` from your project directory
5
+ 1. Run `planexe` from your project directory
6
6
  2. Tell it what to do
7
- 3. It will read and write to files and run commands to produce the code you want
7
+ 3. It will read and write to files and run commands to produce the result you want
8
8
 
9
- Note: Codebuff will run commands in your terminal as it deems necessary to fulfill your request.
9
+ Note: PlanExe will run commands in your terminal as it deems necessary to fulfill your request.
10
10
 
11
11
  ## Installation
12
12
 
13
- To install Codebuff, run:
13
+ To install PlanExe, run:
14
14
 
15
15
  ```bash
16
- npm install -g codebuff
16
+ npm install -g planexe-cli
17
17
  ```
18
18
 
19
19
  (Use `sudo` if you get a permission error.)
20
20
 
21
21
  ## Usage
22
22
 
23
- After installation, you can start Codebuff by running:
23
+ After installation, you can start PlanExe by running:
24
24
 
25
25
  ```bash
26
- codebuff [project-directory]
26
+ planexe [project-directory]
27
27
  ```
28
28
 
29
- If no project directory is specified, Codebuff will use the current directory.
29
+ If no project directory is specified, PlanExe will use the current directory.
30
30
 
31
- Once running, simply chat with Codebuff to say what coding task you want done.
31
+ Once running, simply chat with PlanExe to say what coding or planning task you want done.
32
32
 
33
33
  ## Features
34
34
 
35
35
  - Understands your whole codebase
36
36
  - Creates and edits multiple files based on your request
37
37
  - Can run your tests or type checker or linter; can install packages
38
- - It's powerful: ask Codebuff to keep working until it reaches a condition and it will.
38
+ - It's powerful: ask PlanExe to keep working until it reaches a condition and it will.
39
39
 
40
- Our users regularly use Codebuff to implement new features, write unit tests, refactor code,write scripts, or give advice.
40
+ Users regularly use PlanExe to implement new features, write unit tests, refactor code, write scripts, or get advice.
41
41
 
42
42
  ## Knowledge Files
43
43
 
44
44
  To unlock the full benefits of modern LLMs, we recommend storing knowledge alongside your code. Add a `knowledge.md` file anywhere in your project to provide helpful context, guidance, and tips for the LLM as it performs tasks for you.
45
45
 
46
- Codebuff can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
46
+ PlanExe can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
47
47
 
48
48
  Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
49
49
 
@@ -52,18 +52,14 @@ Some have said every change should be paired with a unit test. In 2024, every ch
52
52
  1. Type '/help' or just '/' to see available commands.
53
53
  2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
54
54
  3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
55
- 4. Press `Esc` or `Ctrl+C` while Codebuff is generating a response to stop it.
55
+ 4. Press `Esc` or `Ctrl+C` while PlanExe is generating a response to stop it.
56
56
 
57
57
  ## Troubleshooting
58
58
 
59
59
  If you are getting permission errors during installation, try using sudo:
60
60
 
61
61
  ```
62
- sudo npm install -g codebuff
62
+ sudo npm install -g planexe-cli
63
63
  ```
64
64
 
65
65
  If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
66
-
67
- ## Feedback
68
-
69
- We value your input! Please email your feedback to `founders@codebuff.com`. Thank you for using Codebuff!
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "planexe-cli",
3
- "version": "0.0.5",
3
+ "version": "0.0.7",
4
4
  "description": "PlanExe CLI — AI planning and coding agent",
5
5
  "license": "MIT",
6
6
  "bin": {