okiro 0.1.0 → 0.1.1
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 +68 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# okiro
|
|
2
|
+
|
|
3
|
+
Sandboxed AI coding variations. Generate N approaches, compare diffs, promote the winner.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g okiro
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
okiro 3 # Create 3 sandboxed variations
|
|
15
|
+
okiro 3 --prompt # With AI directions per variation
|
|
16
|
+
okiro status # See what changed
|
|
17
|
+
okiro compare # Visual diff viewer
|
|
18
|
+
okiro promote var-2 # Apply winning variation
|
|
19
|
+
okiro cleanup # Remove all variations
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## How it works
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
Your Project Sandboxed Variations
|
|
26
|
+
──────────── ────────────────────
|
|
27
|
+
/my-app/ ~/.okiro/projects/my-app/
|
|
28
|
+
├── src/ ├── var-1/ ← AI writes here
|
|
29
|
+
└── ... ├── var-2/ ← AI writes here
|
|
30
|
+
└── var-3/ ← AI writes here
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Okiro clones your project using APFS copy-on-write (macOS) or reflinks (Linux). Clones are instant and use zero disk space until files change.
|
|
34
|
+
|
|
35
|
+
Each AI session (Claude Code, Cursor, Opencode, etc.) works in its own sandbox without knowing it's sandboxed.
|
|
36
|
+
|
|
37
|
+
## Commands
|
|
38
|
+
|
|
39
|
+
| Command | Description |
|
|
40
|
+
|---------|-------------|
|
|
41
|
+
| `okiro <n>` | Create n variations, open terminals |
|
|
42
|
+
| `okiro status` | Show variations and changed files |
|
|
43
|
+
| `okiro diff var-1` | CLI diff against original |
|
|
44
|
+
| `okiro compare` | Web diff viewer (split/unified, syntax highlighting) |
|
|
45
|
+
| `okiro promote var-2` | Copy changes to your project |
|
|
46
|
+
| `okiro promote var-2 --commit "msg"` | Promote and git commit |
|
|
47
|
+
| `okiro cleanup` | Remove all variations |
|
|
48
|
+
|
|
49
|
+
## AI Integration
|
|
50
|
+
|
|
51
|
+
With `--prompt`, okiro creates `AGENTS.md` and `.cursor/rules` in each variation with your directions. The AI picks these up automatically.
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
okiro 3 --prompt "Refactor the auth module"
|
|
55
|
+
# Then enter a direction for each variation:
|
|
56
|
+
# var-1: Use JWT
|
|
57
|
+
# var-2: Use sessions
|
|
58
|
+
# var-3: Use OAuth
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Requirements
|
|
62
|
+
|
|
63
|
+
- Node.js 18+
|
|
64
|
+
- macOS 10.13+ or Linux
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
MIT
|