Skip to content

AGENTS.md

Latest commit

 

History

History
46 lines (35 loc) · 1.61 KB

AGENTS.md

File metadata and controls

46 lines (35 loc) · 1.61 KB

Agent Notes

This repository is a Rootwork scaffold and Worktrunk companion.

Purpose

  • Rootwork manages the workspace container and AI context.
  • Worktrunk manages actual worktree operations.
  • The real git repository for a generated or adopted project lives under repos/<ProjectName>.
  • Worktrees are expected under trees/<branch | sanitize>.
  • rwt is the Rootwork companion CLI.
  • The active rwt runtime is still the shell implementation.
  • There is an in-progress Go rewrite in cmd/rwt, internal/, and go.mod.

Files To Read First

  1. README.md
  2. .worktree-config.yml
  3. rwt
  4. bootstrap-machine
  5. lib/worktree-common.sh

Key Commands

  • ./install-global-tools
  • ./bootstrap-machine
  • rwt init-project [--git <url>]
  • rwt adopt-project
  • rwt doctor
  • wt switch --create <branch>
  • wt list
  • wt remove

Working Rules For This Template

  • Keep Rootwork focused on scaffolding, adoption, validation, and Worktrunk setup.
  • Do not reintroduce overlapping worktree-management commands into rwt.
  • Prefer changing cmd/rwt, internal/, rwt, bootstrap-machine, and scaffold files over adding one-off instructions.
  • When behavior changes, update both the active shell implementation and the in-progress Go implementation unless you are intentionally diverging during migration.
  • Keep the README short and practical.
  • Generated project workspaces should contain .worktree-config.yml, AGENTS.md, .agents/, repos/, and trees/.

Local Skills

  • Project-local skills live under .agents/skills/.
  • The initial local skill for this repo is .agents/skills/rootwork-ops/.