codebuff 1.0.100 → 1.0.101
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 +15 -13
- package/dist/common/constants.js +2 -2
- package/dist/common/constants.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,30 +1,32 @@
|
|
|
1
1
|
# The AI coder for serious engineers
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Codebuff helps you generate better code from your terminal.
|
|
4
4
|
|
|
5
|
-
1. Run `
|
|
5
|
+
1. Run `codebuff` from your project directory
|
|
6
6
|
2. Tell it what to do
|
|
7
7
|
3. It will read and write to files to produce the code you want
|
|
8
8
|
|
|
9
|
+
Note: Codebuff can run commands in your terminal as it deems necessary to fulfill your request.
|
|
10
|
+
|
|
9
11
|
## Installation
|
|
10
12
|
|
|
11
|
-
To install
|
|
13
|
+
To install Codebuff, run:
|
|
12
14
|
|
|
13
15
|
```bash
|
|
14
|
-
npm install -g
|
|
16
|
+
npm install -g codebuff
|
|
15
17
|
```
|
|
16
18
|
|
|
17
19
|
## Usage
|
|
18
20
|
|
|
19
|
-
After installation, you can start
|
|
21
|
+
After installation, you can start Codebuff by running:
|
|
20
22
|
|
|
21
23
|
```bash
|
|
22
|
-
|
|
24
|
+
codebuff [project-directory]
|
|
23
25
|
```
|
|
24
26
|
|
|
25
|
-
If no project directory is specified,
|
|
27
|
+
If no project directory is specified, Codebuff will use the current directory.
|
|
26
28
|
|
|
27
|
-
After running `
|
|
29
|
+
After running `codebuff`, simply chat with it to say what coding task you want done.
|
|
28
30
|
|
|
29
31
|
## Features
|
|
30
32
|
|
|
@@ -33,13 +35,13 @@ After running `manicode`, simply chat with it to say what coding task you want d
|
|
|
33
35
|
- Runs commands in your terminal
|
|
34
36
|
- Scrapes the web to gather information for tasks
|
|
35
37
|
|
|
36
|
-
Ask
|
|
38
|
+
Ask Codebuff to implement small features, write unit tests, write scripts, or give advice.
|
|
37
39
|
|
|
38
40
|
## Knowledge Files
|
|
39
41
|
|
|
40
42
|
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.
|
|
41
43
|
|
|
42
|
-
|
|
44
|
+
Codebuff can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
|
|
43
45
|
|
|
44
46
|
Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
|
|
45
47
|
|
|
@@ -47,11 +49,11 @@ Some have said every change should be paired with a unit test. In 2024, every ch
|
|
|
47
49
|
|
|
48
50
|
1. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
|
|
49
51
|
2. Type `undo` or `redo` to revert or reapply file changes from the conversation.
|
|
50
|
-
3. Press `Esc` or `Ctrl+C` while
|
|
52
|
+
3. Press `Esc` or `Ctrl+C` while Codebuff is generating a response to stop it.
|
|
51
53
|
|
|
52
54
|
## Troubleshooting
|
|
53
55
|
|
|
54
|
-
If you are getting permission errors when installing globally with '-g', or when running `
|
|
56
|
+
If you are getting permission errors when installing globally with '-g', or when running `codebuff`, try [installing node with a version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
|
|
55
57
|
|
|
56
58
|
#### For OSX or Unix, use [nvm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm). Run:
|
|
57
59
|
|
|
@@ -67,4 +69,4 @@ Make sure to uninstall your existing node program. Then get this executable:
|
|
|
67
69
|
|
|
68
70
|
## Feedback
|
|
69
71
|
|
|
70
|
-
We value your input! Please email your feedback to `
|
|
72
|
+
We value your input! Please email your feedback to `founders@codebase.com`. Thank you for using Codebuff!
|
package/dist/common/constants.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;AAErB,QAAA,WAAW,GAAG,GAAG,GAAG,MAAM,CAAA;AAC1B,QAAA,iBAAiB,GAAG,GAAG,GAAG,oBAAoB,CAAA;AAC9C,QAAA,kBAAkB,GAAG,GAAG,GAAG,cAAc,CAAA;AACzC,QAAA,oBAAoB,GAAG,oCAAoC,CAAA;AAE3D,QAAA,yBAAyB,GAAG;IACvC,UAAU;IACV,MAAM;IACN,MAAM;IACN,SAAS;IACT,IAAI;IACJ,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,KAAK;IACL,OAAO;IACP,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,QAAQ;IACR,OAAO;IACP,MAAM;CACP,CAAA;AAEY,QAAA,QAAQ,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,CAAA;AAGnC,QAAA,oBAAoB,GAC/B,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,OAAO;IAC7C,CAAC,CAAC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,UAAU;KACjB;IACH,CAAC,CAAC;QACE,IAAI,EAAE,
|
|
1
|
+
{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":";AAAA,kCAAkC;;;AAErB,QAAA,WAAW,GAAG,GAAG,GAAG,MAAM,CAAA;AAC1B,QAAA,iBAAiB,GAAG,GAAG,GAAG,oBAAoB,CAAA;AAC9C,QAAA,kBAAkB,GAAG,GAAG,GAAG,cAAc,CAAA;AACzC,QAAA,oBAAoB,GAAG,oCAAoC,CAAA;AAE3D,QAAA,yBAAyB,GAAG;IACvC,UAAU;IACV,MAAM;IACN,MAAM;IACN,SAAS;IACT,IAAI;IACJ,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,MAAM;IACN,OAAO;IACP,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,OAAO;IACP,MAAM;IACN,OAAO;IACP,MAAM;IACN,OAAO;IACP,KAAK;IACL,OAAO;IACP,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,QAAQ;IACR,OAAO;IACP,MAAM;CACP,CAAA;AAEY,QAAA,QAAQ,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,CAAA;AAGnC,QAAA,oBAAoB,GAC/B,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,OAAO;IAC7C,CAAC,CAAC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,UAAU;KACjB;IACH,CAAC,CAAC;QACE,IAAI,EAAE,GAAG;QACT,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,MAAM;KACb,CAAA;AACM,QAAA,sBAAsB,GAAG,GAAG,CAAA;AAE5B,QAAA,YAAY,GAAG;IAC1B,MAAM,EAAE,4BAA4B;IACpC,KAAK,EAAE,2BAA2B;CAC1B,CAAA;AAEG,QAAA,YAAY,GAAG;IAC1B,KAAK,EAAE,mBAAmB;IAC1B,SAAS,EAAE,wBAAwB;CAC3B,CAAA;AAEG,QAAA,MAAM,GAAG;IACpB,GAAG,oBAAY;IACf,GAAG,oBAAY;CAChB,CAAA;AAEY,QAAA,YAAY,GAAG,cAAc,CAAA"}
|