orrevan 0.0.0-stage → 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 +71 -2
- package/dist/orrevan.js +266 -0
- package/package.json +40 -4
package/README.md
CHANGED
|
@@ -1,3 +1,72 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Orrevan CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Uncensored AI coding agent for your terminal. It reads your code, edits files and runs commands, always after you confirm. Billed against your Orrevan credit, no subscription.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm i -g orrevan
|
|
7
|
+
orrevan login # paste a key from https://orrevan.com/developers
|
|
8
|
+
orrevan # start in your project folder
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Requires Node.js 20 or newer.
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
orrevan interactive session in the current folder
|
|
17
|
+
orrevan "fix the tests" start with a first prompt
|
|
18
|
+
orrevan -p "question" print mode: answer once and exit (for scripts)
|
|
19
|
+
cat log.txt | orrevan -p "what went wrong?"
|
|
20
|
+
orrevan -c continue the last conversation in this folder
|
|
21
|
+
orrevan models list models and prices
|
|
22
|
+
orrevan balance show your credit
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Options: `-m <model>`, `--plan` (read only), `--yolo` (no approvals, careful).
|
|
26
|
+
|
|
27
|
+
### In the session
|
|
28
|
+
|
|
29
|
+
| Input | |
|
|
30
|
+
|---|---|
|
|
31
|
+
| `/model` | switch model (price per 1M tokens shown) |
|
|
32
|
+
| `/plan`, `/build`, `tab` | plan mode is read only, build mode can change things |
|
|
33
|
+
| `/init` | writes `ORREVAN.md` with notes about the project |
|
|
34
|
+
| `/compact` | summarises the conversation to save tokens |
|
|
35
|
+
| `/clear`, `/cost`, `/balance`, `/yolo`, `/help`, `/exit` | |
|
|
36
|
+
| `!git status` | run a command yourself, the output goes into the context |
|
|
37
|
+
| `esc` | stop the current answer |
|
|
38
|
+
| `\` + enter | new line |
|
|
39
|
+
|
|
40
|
+
### Tools and approvals
|
|
41
|
+
|
|
42
|
+
Orrevan can `read_file`, `list_dir`, `glob` and `grep` freely inside the project folder. `write_file`, `edit_file` and `run_command` always ask first and show a diff or the command. Answer with *Yes*, *Yes for this session*, or *No* plus what it should do instead.
|
|
43
|
+
|
|
44
|
+
The tool protocol is plain text, so it works with every model, including uncensored models without native function calling.
|
|
45
|
+
|
|
46
|
+
### Project instructions
|
|
47
|
+
|
|
48
|
+
If the folder contains `ORREVAN.md`, `AGENTS.md` or `CLAUDE.md`, Orrevan reads it at the start of every request. `/init` creates one.
|
|
49
|
+
|
|
50
|
+
### Configuration
|
|
51
|
+
|
|
52
|
+
The key is stored in `~/.config/orrevan/config.json` (mode 600). Conversations are stored locally in `~/.config/orrevan/sessions`, never on Orrevan's servers.
|
|
53
|
+
|
|
54
|
+
| Variable | |
|
|
55
|
+
|---|---|
|
|
56
|
+
| `ORREVAN_API_KEY` | key instead of `orrevan login` |
|
|
57
|
+
| `ORREVAN_BASE_URL` | default `https://orrevan.com/api/v1` |
|
|
58
|
+
| `ORREVAN_MODEL` | default model |
|
|
59
|
+
|
|
60
|
+
## Development
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
cd cli
|
|
64
|
+
npm install
|
|
65
|
+
npm run build # bundles everything into dist/orrevan.js (no runtime dependencies)
|
|
66
|
+
node dist/orrevan.js
|
|
67
|
+
ORREVAN_BASE_URL=http://localhost:3000/api/v1 node dist/orrevan.js # against a local server
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Publishing: `npm publish` from this folder (runs typecheck and build first).
|
|
71
|
+
|
|
72
|
+
Source layout: `src/agent.ts` (agent loop), `src/prompt.ts` (default system prompt), `src/tools.ts`, `src/protocol.ts` (tool call format), `src/ui/` (Ink terminal UI).
|