Use it when you want the quickest start, or the agent can make HTTP requests but you can't or won't install anything.

How it works

https://app.slipdock.us/api/guide?section=short is written for agents rather than people. It explains how these boards are used (top-level cards are epics and their subcards are the tasks), how to choose what to do next and what to write back while working, then names the guide's other sections (the wiki, runners, automations, a curl line for every call…), each one request away with ?section= and its name. The running server generates it, so it always matches the API.

The whole guide, https://app.slipdock.us/api/guide with no section (or ?section=all), is long: tens of thousands of words, a large share of an agent's context before it has read a card.

The guide is the only thing on the server an agent can read without signing in. Everything about your boards needs a token, including just listing them.

Get started

Paste this at the start of a session:

Work from my Slipdock board at https://app.slipdock.us. Read https://app.slipdock.us/api/guide?section=short and follow it, fetching a section it names when the task needs one. Nothing about my boards is readable until you sign in, so start with the device flow the guide describes and tell me the code to approve.

The agent asks the server for a short code and shows it to you. You open https://app.slipdock.us/activate in a browser where you're signed in, check what's asking, and approve. A few seconds later the agent gets a token that acts as you and saves it in ~/.config/slipdock/token. Your password never reaches the agent, and the code expires after a few minutes.

After it signs in, the agent should read the guide again. With a token, the guide ends with your own boards and their lists, so the agent doesn't have to guess their names.

Choosing what it can do

If you'd rather hand the agent a token yourself, make one under Account → API tokens:

  • Read only lets it summarise, search and report, but change nothing.
  • Read and write is the usual choice for an agent that works the board.
  • A token can also be limited to some boards.

Every token is listed with when and where it was last used, and Revoke cuts off its access immediately.

Good to know

  • Any agent that can make an HTTP request works this way: Claude Code, Codex, Cursor, a shell script or a cron job.
  • Point agents at the URL instead of pasting API details into their instructions. A copied description goes out of date; the URL stays current.
  • ?format=json on the guide returns the same text, plus the vocabularies and endpoint list as data.

How an ask becomes a card

Every agent on a board writes a one-sentence ask up the same way, whichever model it is. The guide's Card shape says:

  • One card when the ask fits one sitting, one agent and one PR and was said in a sentence; an epic with subcards only when it doesn't. Never an epic with one subcard, nor subcards the person didn't imply.
  • Where: under the epic it serves if there is one (search first); otherwise top level, without making an epic to hold it.
  • Three things in the description, each in proportion: what, in the person's words; where, if known; and a done-when line, the stop condition the evidence answers.
  • Don't add an estimate, priority, tags, a due date or an assignee unless the person said so or the board's convention does.
  • Don't repeat the repo's rules (tests, every door, the handbook line): whoever builds it reads those from the handbook and the repo.
  • Two readings: write the obvious one and note the other in the description; ask only when they differ materially, once, before filing.
  • A bar item made moot by a later, cited decision or rule: read it the obvious way and say so. Not a wait.
  • Dependencies: blocked-by means can't start until, not should come after: set it where a card builds on another's code, schema or decision, and use list position for mere preference.

A board's handbook can override these: the Card shape section of its Playbook page wins wherever it says otherwise.