From 712d9c0dff016f6473b13c1ec84bb17353a276ef Mon Sep 17 00:00:00 2001 From: oc Date: Wed, 12 Aug 2026 13:10:12 -0700 Subject: [PATCH] Document cloning: agents pull the repo instead of copying files --- AGENT-ONBOARDING.md | 23 +++++++++++++++++------ README.md | 7 +++++++ 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/AGENT-ONBOARDING.md b/AGENT-ONBOARDING.md index 91a3650..df2f529 100644 --- a/AGENT-ONBOARDING.md +++ b/AGENT-ONBOARDING.md @@ -17,11 +17,19 @@ You are ``. Give yourself working access to Vikunja at ### Facts you need -- Tooling lives at `/srv/pods/vikunja-agents/` on `reptar`: `vk` (CLI), - `vkclient.py` (shared client), `vikunja_mcp.py` (MCP server, stdio). - Standard-library Python only — no virtualenv, no pip 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`. +- The tooling is a public repo. Clone it on whatever machine you run on — no + credentials needed, and standard-library Python only, so there is nothing to + install: + + ```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` (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 @@ -97,7 +105,10 @@ mcp: ``` `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 the same ground. diff --git a/README.md b/README.md index e45464f..a0cbe6e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,12 @@ # 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 Python only — no virtualenv on any device.