documentation drift control

Sweepr does the doc work you keep putting off.

Keep docs updated from the repo, prevent documentation drift, and turn messy worklogs into clear, verified changes. Connect the docs once; Sweepr handles the alignment pass when code moves.

full loop

From app setup to clean doc updates in four moves.

Recommended Flow

Step 1

Connect in the app

Connect your repo, choose included repos, and add any existing Notion or repo docs first.

Step 2

Install the skill

Adds the Sweepr documentation-linking skill to Codex and Claude Code.

npm install -g sweepr-code

Step 3

Sign in once

Stores one local Sweepr session for this machine. Future runs reuse it automatically.

sweepr-code login

Step 4

Run Sweepr

Run from a local checkout. Codex uses `$sweepr`; Claude Code uses `/sweepr`.

$sweepr /sweepr

Other Commands

Check Sweepr files

Checks that Sweepr is ready in the current project.

sweepr-code check

Refresh link note

Writes minimal .sweepr config and context hints for this checkout.

sweepr-code init

Install repo-local assets

Copies Sweepr agent assets into the repository only when that scope is wanted.

sweepr-code repo-install

Diagnose Notion access

Checks auth, workspace, URL parsing, and page sharing for a linked Notion doc.

sweepr-code notion doctor <url-or-page-id>

Append Notion update

Writes a bounded linked-page update through Sweepr's stored Notion auth.

sweepr-code notion update <url-or-page-id> --file update.md --yes

Write optional hook templates

Writes templates under .sweepr/hooks and never modifies .git/hooks.

sweepr-code hooks install
start

Connect once. Let Sweepr keep the docs honest.

Connect your repo, choose included repos, and link docs when they exist. The next `$sweepr` or `/sweepr` run matches the local Git remote and uses that registry.