Kuickr · Runbook · Showcase
Kuickr hosts your repo's docs at clean URLs — and it works like git: bind a folder once, then status → pull → push to keep it in sync. This is the playbook: publish a whole folder of pages (not one doc), split subtrees across Spaces, and never clobber a teammate's edit.
kuickr push pavelabs/docs --dir docs uploads every file under docs/ as pages under pavelabs/docs. Then cd docs and run status/pull/push with no flags.
The real sync loop — sync first so you see what others changed, then push.
Same mental model: a merge base, conflict detection, force-with-lease.
Every push records a per-file checksum in .kuickr/manifest.json — the shared base. If the server changed since you last synced, push refuses to overwrite and tells you to pull first (or --force to take your side). No silent last-writer-wins. That's why the rule is: sync first, push second.
Multi-page push and multi-bind need a recent build.
brew upgrade kuickr # expect 0.20.0+ kuickr whoami # confirm you're logged in
Point a local directory at a <space>/<folder>. First push creates the folder on the server and drops a .kuickr/ binding so future syncs need no flags.
kuickr push pavelabs/docs --dir docs
Inside the bound dir, the verbs take no arguments.
cd docs kuickr status # what differs? kuickr pull # get teammates' changes kuickr push # send yours
<space>/<folder> is the destination; --dir is the local source. They're independent — the local path need not match the folder name.
Explicit destination + source. Best the first time.
kuickr push pavelabs/docs --dir docs
Already bound (you cloned or pushed here before)? No target needed.
cd docs && kuickr push
The classic split-flag form still works.
kuickr push docs --space pavelabs --dir docs
You wanted docs/plans/notifications as its own thing — two clean ways.
Publishes just those pages under pavelabs/notifications at kuickr.co/pavelabs/notifications.
kuickr push pavelabs/notifications --dir docs/plans/notifications
docs but bind it separately (multi-bind)Bind the subtree to its own Space/folder. Now a parent docs push auto-skips it — no duplication, no config.
cd docs/plans/notifications
kuickr push pavelabs/notifications --dir .
cd -
kuickr push pavelabs/docs --dir docs
# ✓ skipped 1 separately-bound subtree(s): plans/notifications.kuickrignore at the push-dir root (gitignore-style) or pass --exclude <glob>. Excluded paths are never uploaded and never pruned.
--forceThe three things everyone hits first — answered.
--dir is the local source (default .); <space>/<folder> is the destination. Run the explicit form from anywhere, or stand inside a bound folder and go flag-free — but the no-arg form reads the binding from the dir you're in (the one holding .kuickr/); it doesn't hunt upward.
kuickr push pavelabs/docs --dir path/to/docs # explicit — from anywhere cd path/to/docs && kuickr push # bound dir — no args kuickr push docs --space pavelabs --dir docs # legacy split flags
A conflict means a file changed on both sides since your last sync — .kuickr/manifest.json is the shared base it compares against. push stops with exit code 3 and lists them. It's git-style: nothing auto-merges.
kuickr status # see exactly what diverged kuickr pull # brings server down; KEEPS your copy on a 2-way conflict # → hand-merge the conflicted file(s), then: kuickr push # now a clean fast-forward
.kuickr/manifest.json. It's the machine's record of what you last synced, not a file to merge. If it's out of whack, kuickr status shows the truth; worst case kuickr pull rebuilds it — or re-clone into a fresh dir.
--forceOnly after you've looked at the diff and consciously decided one side wins.
base_sha lease.status (or push --dry-run) first, never force reflexively. On a shared folder --force can clobber a teammate's newer work — pull & merge unless you're certain yours should win.Paste this to a Claude or GPT agent with CLI access and it'll run the whole flow.
Update the kuickr CLI (brew upgrade kuickr), then publish my PaveLabs docs — I want MULTIPLE pages, not a single doc. First sync so you don't clobber others' work: kuickr status pavelabs/docs --dir docs kuickr pull pavelabs/docs --dir docs kuickr push pavelabs/docs --dir docs Then keep docs/plans/notifications as its own Space folder: kuickr push pavelabs/notifications --dir docs/plans/notifications Report the published URLs.
--dir = local source, <space>/<folder> = destination.--force takes server).git clone..kuickrignore.0 ok · 2 auth · 3 conflict — scriptable in CI.