You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Manicode helps you generate better code from your terminal.
3
+
Codebuff helps you generate better code from your terminal.
4
4
5
-
1. Run `manicode` from your project directory
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 Manicode, run:
13
+
To install Codebuff, run:
12
14
13
15
```bash
14
-
npm install -g manicode
16
+
npm install -g codebuff
15
17
```
16
18
17
19
## Usage
18
20
19
-
After installation, you can start Manicode by running:
21
+
After installation, you can start Codebuff by running:
20
22
21
23
```bash
22
-
manicode [project-directory]
24
+
codebuff [project-directory]
23
25
```
24
26
25
-
If no project directory is specified, Manicode will use the current directory.
27
+
If no project directory is specified, Codebuff will use the current directory.
26
28
27
-
After running `manicode`, simply chat with it to say what coding task you want done.
29
+
After running `codebuff`, simply chat with it to say what coding task you want done.
28
30
29
31
## Features
30
32
@@ -33,25 +35,25 @@ 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 Manicode to implement small features, write unit tests, write scripts, or give advice.
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
-
Manicode can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
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
46
48
## Tips
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 Manicode is generating a response to stop it.
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 `manicode`, try [installing node with a version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
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 `james@manicode.ai`. Thank you for using Manicode!
72
+
We value your input! Please email your feedback to `founders@codebase.com`. Thank you for using Codebuff!
0 commit comments