oc/vikunja-agents
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document cloning: agents pull the repo instead of copying files

Browse Source
This commit is contained in:
oc
2026-08-12 13:10:12 -07:00
parent 2a73f2ef5e
commit 712d9c0dff
2 changed files with 24 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENT-ONBOARDING.md
+17 -6
View File
@@ -17,11 +17,19 @@ You are `<AGENT_NAME>`. Give yourself working access to Vikunja at
### Facts you need ### Facts you need
- Tooling lives at `/srv/pods/vikunja-agents/` on `reptar`: `vk` (CLI), - The tooling is a public repo. Clone it on whatever machine you run on — no
`vkclient.py` (shared client), `vikunja_mcp.py` (MCP server, stdio). credentials needed, and standard-library Python only, so there is nothing to
Standard-library Python only — no virtualenv, no pip install. install:
- If you are **not** on `reptar`, copy those three files to the machine you run
on (`~/opt/vikunja-agents/`) and symlink `vk` onto your `PATH`. ```sh
git clone https://git.dominat.us/oc/vikunja-agents.git ~/opt/vikunja-agents
mkdir -p ~/.local/bin && ln -sf ~/opt/vikunja-agents/vk ~/.local/bin/vk
```
It gives you `vk` (CLI), `vikunja_mcp.py` (MCP server, stdio) and
`vkclient.py` (shared client). To update later: `git -C ~/opt/vikunja-agents pull`.
- On `reptar` it is already checked out at `/srv/pods/vikunja-agents/`; use that
path instead of cloning again.
- Auth is a Vikunja **API token**, read from `~/.config/vikunja-agents/config.json` - Auth is a Vikunja **API token**, read from `~/.config/vikunja-agents/config.json`
(mode 0600) or `$VIKUNJA_TOKEN`. Select an identity with `$VIKUNJA_PROFILE`. (mode 0600) or `$VIKUNJA_TOKEN`. Select an identity with `$VIKUNJA_PROFILE`.
- Your account must already exist. The normal shape is a **bot user**: a local - Your account must already exist. The normal shape is a **bot user**: a local
@@ -97,7 +105,10 @@ mcp:
``` ```
`other` — the server speaks MCP over stdio (JSON-RPC 2.0, newline-delimited). `other` — the server speaks MCP over stdio (JSON-RPC 2.0, newline-delimited).
Run `/srv/pods/vikunja-agents/vikunja_mcp.py` with `VIKUNJA_PROFILE` set. If your Run `vikunja_mcp.py` with `VIKUNJA_PROFILE` set.
In every snippet above, use `/srv/pods/vikunja-agents/vikunja_mcp.py` on `reptar`
and `~/opt/vikunja-agents/vikunja_mcp.py` wherever you cloned it. If your
harness cannot speak MCP, skip this step and use the `vk` CLI instead; it covers harness cannot speak MCP, skip this step and use the `vk` CLI instead; it covers
the same ground. the same ground.
README.md
+7
View File
@@ -1,5 +1,12 @@
# vikunja-agents # vikunja-agents
git clone https://git.dominat.us/oc/vikunja-agents.git
Public read, push restricted to the owner. On `reptar` the working copy is
`/srv/pods/vikunja-agents/`, which is also where the quadlets and the Claude Code
MCP registration point.
Harness-agnostic glue between Vikunja and agent harnesses. Standard library Harness-agnostic glue between Vikunja and agent harnesses. Standard library
Python only — no virtualenv on any device. Python only — no virtualenv on any device.