@openbuff/cli 1.1.3 → 1.1.4
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 +14 -8
- package/package.json +15 -3
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
# The most powerful coding agent
|
|
1
|
+
# Openbuff — The most powerful coding agent
|
|
2
2
|
|
|
3
|
-
Openbuff is
|
|
3
|
+
Openbuff is an open-source, **local-first** agentic coding CLI that edits your codebase through natural language instructions using your configured OpenAI-compatible or Anthropic-compatible providers. No backend fallback, no credits, no subscription — bring your own keys (BYOK).
|
|
4
|
+
|
|
5
|
+
Instead of using one model for everything, Openbuff coordinates **specialized agents** that work together to understand your project and make precise changes.
|
|
4
6
|
|
|
5
7
|
1. Run `openbuff` from your project directory
|
|
6
8
|
2. Tell it what to do
|
|
@@ -13,7 +15,7 @@ Note: Openbuff will run commands in your terminal as it deems necessary to fulfi
|
|
|
13
15
|
To install Openbuff, run:
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
|
-
npm install -g openbuff
|
|
18
|
+
npm install -g @openbuff/cli
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
(Use `sudo` if you get a permission error.)
|
|
@@ -35,7 +37,10 @@ Once running, simply chat with Openbuff to say what coding task you want done.
|
|
|
35
37
|
- Understands your whole codebase
|
|
36
38
|
- Creates and edits multiple files based on your request
|
|
37
39
|
- Can run your tests or type checker or linter; can install packages
|
|
38
|
-
- It's powerful: ask Openbuff to keep working until it reaches a condition and it will
|
|
40
|
+
- It's powerful: ask Openbuff to keep working until it reaches a condition and it will
|
|
41
|
+
- **Multi-agent orchestration** — a File Picker Agent, Planner Agent, Editor Agent, and Reviewer Agent work together so each step gets the right specialist
|
|
42
|
+
- **Provider-flexible (BYOK)** — route each agent to OpenAI, Anthropic/Claude, ChatGPT/Codex OAuth, OpenRouter, opencode gateways, GLM/Z.ai, or local Ollama/LM Studio
|
|
43
|
+
- **Custom agents** — run the `/init` command to create your own `.agents/` with TypeScript generators for programmatic control
|
|
39
44
|
|
|
40
45
|
Our users regularly use Openbuff to implement new features, write unit tests, refactor code, write scripts, or give advice.
|
|
41
46
|
|
|
@@ -49,19 +54,20 @@ Some have said every change should be paired with a unit test. In 2024, every ch
|
|
|
49
54
|
|
|
50
55
|
## Tips
|
|
51
56
|
|
|
52
|
-
1. Type
|
|
57
|
+
1. Type `/help` or just `/` to see available commands.
|
|
53
58
|
2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
|
|
54
59
|
3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
|
|
55
60
|
4. Press `Esc` or `Ctrl+C` while Openbuff is generating a response to stop it.
|
|
61
|
+
5. Run `/setup opencode-go` (or `openai`, `anthropic`, `codex`, `openrouter`, `ollama`, `glm`) to configure a provider, then `/provider` to manage config and `/models` to route individual agents.
|
|
56
62
|
|
|
57
63
|
## Troubleshooting
|
|
58
64
|
|
|
59
65
|
### Permission Errors
|
|
60
66
|
|
|
61
|
-
If you are getting permission errors during installation, try using sudo
|
|
67
|
+
If you are getting permission errors during installation, try using `sudo`:
|
|
62
68
|
|
|
63
69
|
```
|
|
64
|
-
sudo npm install -g openbuff
|
|
70
|
+
sudo npm install -g @openbuff/cli
|
|
65
71
|
```
|
|
66
72
|
|
|
67
73
|
If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
|
|
@@ -104,4 +110,4 @@ Both `http://` and `https://` proxy URLs are supported. Proxy authentication is
|
|
|
104
110
|
|
|
105
111
|
## Feedback
|
|
106
112
|
|
|
107
|
-
We value your input! Please open a GitHub issue with your feedback. Thank you for using Openbuff!
|
|
113
|
+
We value your input! Please open a [GitHub issue](https://github.com/AnzoBenjamin/openbuff/issues) with your feedback. Thank you for using Openbuff!
|
package/package.json
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openbuff/cli",
|
|
3
|
-
"version": "1.1.
|
|
4
|
-
"description": "AI coding agent",
|
|
3
|
+
"version": "1.1.4",
|
|
4
|
+
"description": "An AI coding agent that writes code for you. Run it from your project directory, tell it what to do, and it reads and writes files, runs commands, and iterates until the task is done. Supports sub-agents, custom tools, and Bring-Your-Own-Key providers.",
|
|
5
5
|
"license": "MIT",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"ai",
|
|
8
|
+
"agent",
|
|
9
|
+
"coding-agent",
|
|
10
|
+
"cli",
|
|
11
|
+
"terminal",
|
|
12
|
+
"developer-tools",
|
|
13
|
+
"code-generator",
|
|
14
|
+
"assistant",
|
|
15
|
+
"automation",
|
|
16
|
+
"tui"
|
|
17
|
+
],
|
|
6
18
|
"bin": {
|
|
7
19
|
"openbuff": "index.js",
|
|
8
20
|
"cb": "index.js"
|
|
@@ -36,7 +48,7 @@
|
|
|
36
48
|
"type": "git",
|
|
37
49
|
"url": "https://github.com/AnzoBenjamin/openbuff.git"
|
|
38
50
|
},
|
|
39
|
-
"homepage": "https://
|
|
51
|
+
"homepage": "https://openbuff.dev",
|
|
40
52
|
"publishConfig": {
|
|
41
53
|
"access": "public"
|
|
42
54
|
}
|