Skip to content

install.md

Latest commit

 

History

History
86 lines (62 loc) · 2.61 KB

install.md

File metadata and controls

86 lines (62 loc) · 2.61 KB
Raw

Install Syncwheel

Use this file when a user gives an AI agent a markdown install prompt and asks it to install or bootstrap Syncwheel.

Syncwheel is a deterministic Git maintenance tool for PR stacks, integration branches, pinned deployment-channel branches, and multi-agent worktrees.

What To Do

  1. Inspect the host for Python 3.11+, Git, and uv.
  2. Install the syncwheel CLI if it is missing.
  3. Verify the CLI.
  4. Install the Syncwheel companion skill through Agentwheel when Agentwheel is available.
  5. Run only read-only repo diagnostics unless the user explicitly asks for branch, worktree, push, or recovery changes.

Install The CLI

Check whether Syncwheel is already available:

syncwheel --version
syncwheel --help

Install the production tool with uv:

uv tool install "git+https://github.com/NestDevLab/syncwheel"

For Syncwheel development from a local checkout:

uv tool install --editable .

If the repo checkout is available but the CLI is not on PATH, use the script directly:

python3 scripts/syncwheel.py --version
python3 scripts/syncwheel.py --help

Verify A Repository

Run these from the target repository:

syncwheel repo tracking status
syncwheel reconcile
syncwheel validate

reconcile is a dry-run diagnostic by default. Do not run sync, publish, reconcile --apply, branch rebuilds, or push commands unless the user asked for that exact scope.

Install The Companion Skill

When Agentwheel is available, install the Syncwheel skill into the active runtime. For a project-local Codex setup:

agentwheel doctor --adapter codex --local --skill syncwheel --source github:NestDevLab/syncwheel
agentwheel install github:NestDevLab/syncwheel --adapter codex --local --skill syncwheel

For Claude user scope:

agentwheel doctor --adapter claude --user --skill syncwheel --source github:NestDevLab/syncwheel
agentwheel install github:NestDevLab/syncwheel --adapter claude --user --skill syncwheel

Success Criteria

  • syncwheel --version works, or the checkout script fallback works.
  • syncwheel repo tracking status runs in the target repo.
  • The companion skill is installed if the user requested it and Agentwheel is available.
  • Any branch, worktree, integration, or push mutation was explicitly requested.
  • Every channel create/edit/refresh/promotion/resolution/apply/publish/close was explicitly requested and used its preview's exact planDigest with --apply; uncertain outcomes were observed with channel operation reconcile, never retried.
  • Channel publication was not reported as an environment deployment.