Kuickr · Runbook · Showcase

Push PaveLabs docs to Kuickr

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.

space: pavelabs · owner: platform · rev 2 · 2026-07-21 · CLI ≥ v0.20.0

The 10-second version. From your repo: 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.

Watch a push happen

The real sync loop — sync first so you see what others changed, then push.

It's git for docs

Same mental model: a merge base, conflict detection, force-with-lease.

💻
your repo
docs/ + .kuickr/
push ▶
◀ pull
🌐
kuickr.co
/pavelabs/…

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.

One-time setup

  1. Update the CLI

    Multi-page push and multi-bind need a recent build.

    brew upgrade kuickr   # expect 0.20.0+
    kuickr whoami         # confirm you're logged in
  2. Push the folder (auto-creates + binds)

    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
  3. From then on, just sync

    Inside the bound dir, the verbs take no arguments.

    cd docs
    kuickr status   # what differs?
    kuickr pull     # get teammates' changes
    kuickr push     # send yours

Naming the target — 3 forms

<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

Pushing just the notifications plans

You wanted docs/plans/notifications as its own thing — two clean ways.

A · Push the subtree to its own folder

Publishes just those pages under pavelabs/notifications at kuickr.co/pavelabs/notifications.

kuickr push pavelabs/notifications --dir docs/plans/notifications

B · Keep it inside 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
Not separately bound? To exclude a subtree that isn't its own binding (build output, vendored trees), drop a .kuickrignore at the push-dir root (gitignore-style) or pass --exclude <glob>. Excluded paths are never uploaded and never pruned.

Directory · conflicts · --force

The three things everyone hits first — answered.

Which directory does it push?

--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

Hit a conflict? Pull, merge, push

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
Don't hand-edit .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.

When to --force

Only after you've looked at the diff and consciously decided one side wins.

push --force
My local is authoritative — overwrite the server even though it diverged. Bypasses the 3-way guard and the base_sha lease.
pull --force
The opposite — take the server version, discard your local edits.
the rule
Run 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.

Hand it to an agent

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.

Quick reference

push
Upload a whole folder as pages. --dir = local source, <space>/<folder> = destination.
pull
Download server pages; keeps your local edits on conflict (--force takes server).
status
Show what differs: to-push · to-pull · conflicts. Run before pushing.
clone
Download and bind a folder in one shot — like git clone.
--exclude
Skip a glob this push (repeatable); unioned with a committed .kuickrignore.
--dry-run
Show what push would upsert / prune / exclude — change nothing.
exit codes
0 ok · 2 auth · 3 conflict — scriptable in CI.
source: kuickr/guides/kuickr-runbook.html · rev 2 · 2026-07-21 · hosted on Kuickr