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