vicunia 0.0.0-stage → 0.1.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/LICENSE +21 -0
- package/README.md +59 -2
- package/dist/vicunia.cjs +1341 -0
- package/package.json +40 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 goahmedben
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,60 @@
|
|
|
1
|
-
#
|
|
1
|
+
# vicunia
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The runner for [Vicunia](https://vicunia.si): your users ask, your agent builds, you approve.
|
|
4
|
+
|
|
5
|
+
Vicunia collects feature requests and bug reports from your users, turns them into specs, and asks you to approve them. This CLI runs on **your** machine. It picks up approved jobs, runs **your** coding agent in a git worktree, runs your tests, checks the rules on the real diff, and pushes a branch. Vicunia then opens the pull request, waits for CI, and merges when your rules allow.
|
|
6
|
+
|
|
7
|
+
Your code and your git credentials never leave your machine. Vicunia only receives the job status, diff stats (paths and line counts) and short, redacted log excerpts.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
You need Node 22 or later, git, and a coding agent on `PATH`. Claude Code is the default.
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g vicunia
|
|
15
|
+
vicunia --help
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Connect
|
|
19
|
+
|
|
20
|
+
1. In Vicunia, open **Runners → Add a runner** and copy the login command. The token is shown once.
|
|
21
|
+
2. Log in, link each project to its local checkout, and start:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
vicunia login --token vr_… --server https://actions.vicunia.si
|
|
25
|
+
vicunia link habits --path ~/code/habits
|
|
26
|
+
vicunia start
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
`vicunia link` prints the install and test commands it will run for that project and pins them. If they change on the server, the runner refuses those jobs until you run `vicunia link` again.
|
|
30
|
+
|
|
31
|
+
## Commands
|
|
32
|
+
|
|
33
|
+
| Command | What it does |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| `vicunia login --token <t> --server <url>` | Connect this machine. The config lives in `~/.vicunia` (or `$VICUNIA_HOME`). |
|
|
36
|
+
| `vicunia link <project> --path <dir>` | Use a local checkout for a project and pin its commands. |
|
|
37
|
+
| `vicunia unlink <project>` | Stop running jobs for a project. |
|
|
38
|
+
| `vicunia agent set <project\|all> "<command>"` | Use another agent. The command must contain `{prompt_file}`. |
|
|
39
|
+
| `vicunia agent show <project>` | Show the agent command for a project. |
|
|
40
|
+
| `vicunia env allow <NAME>` / `deny <NAME>` | Pass one more environment variable to the agent, for example `ANTHROPIC_API_KEY`. |
|
|
41
|
+
| `vicunia start [--once] [--poll <s>]` | Claim and run jobs until Ctrl-C. The first Ctrl-C hands the current job back. |
|
|
42
|
+
| `vicunia status` | Show the server, the runner and the linked projects. |
|
|
43
|
+
|
|
44
|
+
Any agent that can read its task from a file works:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
vicunia agent set habits "aider --message-file {prompt_file} --yes-always"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Safety
|
|
51
|
+
|
|
52
|
+
- The agent starts without a shell, gets the task as a file, and sees a minimal environment. Vicunia's token is never passed to it.
|
|
53
|
+
- A change that touches a protected path (`.env*`, migrations, auth, payments, CI workflows, lockfiles) is blocked before push.
|
|
54
|
+
- The runner pushes only `vicunia/…` branches. Merging is up to your rules and your approval.
|
|
55
|
+
|
|
56
|
+
## Update
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npm install -g vicunia@latest
|
|
60
|
+
```
|