@ukibbb/buli 0.14.0 → 1.0.0
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 +67 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,79 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Buli
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
An AI coding assistant for your terminal.
|
|
4
|
+
|
|
5
|
+
Explore a codebase, work on files, run commands, and resume conversations by
|
|
6
|
+
project. Connect OpenAI through ChatGPT/Codex, Kimi Code, or DeepSeek.
|
|
7
|
+
|
|
8
|
+
[Documentation](https://github.com/ukibbb/buliV2#readme) ·
|
|
9
|
+
[Releases](https://github.com/ukibbb/buliV2/releases) ·
|
|
10
|
+
[Report an issue](https://github.com/ukibbb/buliV2/issues)
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
Requires **Node.js 18 or newer** and npm. Native releases support **macOS and
|
|
15
|
+
Linux on ARM64 and x64**. Bun is not required.
|
|
6
16
|
|
|
7
17
|
```bash
|
|
8
18
|
npm install --global @ukibbb/buli
|
|
9
19
|
buli --version
|
|
10
20
|
```
|
|
11
21
|
|
|
12
|
-
|
|
22
|
+
The package downloads the matching native release from GitHub, verifies its
|
|
23
|
+
published SHA-256 checksum, and installs the executable and private ripgrep and
|
|
24
|
+
fd binaries inside the npm package.
|
|
25
|
+
|
|
26
|
+
Choose either npm or the standalone installer described in the main
|
|
27
|
+
[README](https://github.com/ukibbb/buliV2#installation), not both, to avoid
|
|
28
|
+
multiple `buli` commands in your `PATH`.
|
|
29
|
+
|
|
30
|
+
## Quick start
|
|
31
|
+
|
|
32
|
+
Connect a provider:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
buli login
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Launch Buli from your project directory:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
cd your-project
|
|
42
|
+
buli
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Use `/model` to select a model, `/sessions` to reopen a conversation, and
|
|
46
|
+
`/branch` to explore a read-only side question. Add project conventions in
|
|
47
|
+
`.buli/BULI.md`; restart Buli after changing that file.
|
|
48
|
+
|
|
49
|
+
OpenAI uses ChatGPT/Codex OAuth, not `OPENAI_API_KEY`. Kimi Code and DeepSeek use
|
|
50
|
+
API keys. Model access, limits, and charges depend on your provider account.
|
|
51
|
+
|
|
52
|
+
## Safety
|
|
53
|
+
|
|
54
|
+
Buli is **not a sandbox**. File tools can access paths outside the project, and
|
|
55
|
+
shell commands run with your user account's permissions. Approval instructions
|
|
56
|
+
are conversational rules, not an enforced security boundary.
|
|
57
|
+
|
|
58
|
+
Conversation content may be sent to model providers. Local credentials and
|
|
59
|
+
history are not encrypted by Buli. Read the
|
|
60
|
+
[data and safety guide](https://github.com/ukibbb/buliV2#data-and-safety) before
|
|
61
|
+
working with sensitive code.
|
|
62
|
+
|
|
63
|
+
## Updates
|
|
13
64
|
|
|
14
|
-
|
|
65
|
+
Update npm-managed installations through npm:
|
|
15
66
|
|
|
16
67
|
```bash
|
|
17
68
|
npm install --global @ukibbb/buli@latest
|
|
18
69
|
```
|
|
70
|
+
|
|
71
|
+
Release candidates, when published, use the `next` tag:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm install --global @ukibbb/buli@next
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
## License
|
|
78
|
+
|
|
79
|
+
[MIT](https://github.com/ukibbb/buliV2/blob/main/LICENSE).
|