Skip to content

Commit 8a791fa

Browse files
committed
Update cli/release/README.md
1 parent c6e1863 commit 8a791fa

File tree

1 file changed

+16
-18
lines changed

1 file changed

+16
-18
lines changed

cli/release/README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,49 @@
1-
# 🚀 Codecane - The most powerful coding agent (STAGING)
1+
# The most powerful coding agent
22

3-
**⚠️ This is a staging/beta release for testing purposes.**
3+
Codebuff is a CLI tool that writes code for you.
44

5-
Codecane is a CLI tool that writes code for you.
6-
7-
1. Run `codecane` from your project directory
5+
1. Run `codebuff` from your project directory
86
2. Tell it what to do
97
3. It will read and write to files and run commands to produce the code you want
108

11-
Note: Codecane will run commands in your terminal as it deems necessary to fulfill your request.
9+
Note: Codebuff will run commands in your terminal as it deems necessary to fulfill your request.
1210

1311
## Installation
1412

15-
To install Codecane (staging), run:
13+
To install Codebuff, run:
1614

1715
```bash
18-
npm install -g codecane@beta
16+
npm install -g codebuff
1917
```
2018

2119
(Use `sudo` if you get a permission error.)
2220

2321
## Usage
2422

25-
After installation, you can start Codecane by running:
23+
After installation, you can start Codebuff by running:
2624

2725
```bash
28-
codecane [project-directory]
26+
codebuff [project-directory]
2927
```
3028

31-
If no project directory is specified, Codecane will use the current directory.
29+
If no project directory is specified, Codebuff will use the current directory.
3230

33-
Once running, simply chat with Codecane to say what coding task you want done.
31+
Once running, simply chat with Codebuff to say what coding task you want done.
3432

3533
## Features
3634

3735
- Understands your whole codebase
3836
- Creates and edits multiple files based on your request
3937
- Can run your tests or type checker or linter; can install packages
40-
- It's powerful: ask Codecane to keep working until it reaches a condition and it will.
38+
- It's powerful: ask Codebuff to keep working until it reaches a condition and it will.
4139

42-
Our users regularly use Codecane to implement new features, write unit tests, refactor code, write scripts, or give advice.
40+
Our users regularly use Codebuff to implement new features, write unit tests, refactor code,write scripts, or give advice.
4341

4442
## Knowledge Files
4543

4644
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.
4745

48-
Codecane can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
46+
Codebuff can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
4947

5048
Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
5149

@@ -54,18 +52,18 @@ Some have said every change should be paired with a unit test. In 2024, every ch
5452
1. Type '/help' or just '/' to see available commands.
5553
2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
5654
3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
57-
4. Press `Esc` or `Ctrl+C` while Codecane is generating a response to stop it.
55+
4. Press `Esc` or `Ctrl+C` while Codebuff is generating a response to stop it.
5856

5957
## Troubleshooting
6058

6159
If you are getting permission errors during installation, try using sudo:
6260

6361
```
64-
sudo npm install -g codecane@beta
62+
sudo npm install -g codebuff
6563
```
6664

6765
If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
6866

6967
## Feedback
7068

71-
We value your input! Please email your feedback to `founders@codebuff.com`. Thank you for using Codecane!
69+
We value your input! Please email your feedback to `founders@codebuff.com`. Thank you for using Codebuff!

0 commit comments

Comments
 (0)