zizou-ai 0.1.0 → 0.1.2
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 +21 -7
- package/dist/cli.js +746 -60
- package/doc/doc-filelist.js +1 -0
- package/doc/doc-script.js +228 -0
- package/doc/doc-style.css +403 -0
- package/join.json +1 -0
- package/package.json +2 -2
- package/src/agent/run-turn.ts +33 -1
- package/src/cli.tsx +1 -1
- package/src/context/build-system-prompt.ts +65 -3
- package/src/context/repo-map.ts +13 -3
- package/src/tools/edit-file.ts +9 -3
- package/src/tools/file-operations.ts +95 -0
- package/src/tools/glob.ts +84 -8
- package/src/tools/grep.ts +56 -9
- package/src/tools/index.ts +4 -0
- package/src/tools/manage-ports.ts +174 -0
- package/src/tools/manage-tasks.ts +98 -0
- package/src/tools/read-file.ts +3 -1
- package/src/tools/run-background.ts +70 -0
- package/src/tools/run-bash.ts +26 -3
- package/src/tools/task-registry.ts +139 -0
package/README.md
CHANGED
|
@@ -2,8 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
Zizou is an open-source AI coding agent CLI tool built with TypeScript, React (Ink), and the Vercel AI SDK. It allows you to chat with Claude 3.5 Sonnet or GPT-4o directly in your terminal, and grants the AI the ability to read files, edit files (safely), and run sandboxed terminal commands with your explicit approval.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Getting Started
|
|
6
6
|
|
|
7
|
+
You can install and run Zizou using NPM, Docker, or from source. *(On first run, the CLI will present a setup screen asking you to select a provider and input an API key).*
|
|
8
|
+
|
|
9
|
+
### Option 1: Using NPM (Recommended)
|
|
10
|
+
You can download and install Zizou globally via NPM (requires Node.js):
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g zizou-ai
|
|
13
|
+
```
|
|
14
|
+
Once installed, you can launch the CLI from anywhere by simply running:
|
|
15
|
+
```bash
|
|
16
|
+
zizou
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Option 2: Using Docker
|
|
20
|
+
You can download and run Zizou inside an isolated Docker container without installing any dependencies:
|
|
21
|
+
```bash
|
|
22
|
+
docker run -it arnv17/zizou:latest
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### Option 3: From Source (Development)
|
|
7
26
|
Ensure you have [Bun](https://bun.sh) installed.
|
|
8
27
|
|
|
9
28
|
```bash
|
|
@@ -13,15 +32,10 @@ cd zizou
|
|
|
13
32
|
|
|
14
33
|
# Install dependencies
|
|
15
34
|
bun install
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
## Running Zizou
|
|
19
35
|
|
|
20
|
-
|
|
21
|
-
```bash
|
|
36
|
+
# Run the CLI
|
|
22
37
|
bun run src/cli.tsx
|
|
23
38
|
```
|
|
24
|
-
*(On first run, the CLI will present a setup screen asking you to select a provider and input an API key).*
|
|
25
39
|
|
|
26
40
|
## Core Features & Slash Commands
|
|
27
41
|
|