### rrt agents install examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Examples of installing bundled rrt user agent definitions. ```bash rrt agents install --target claude-local ``` ```bash rrt agents install --target claude-local --target codex-local ``` ```bash rrt agents install --target claude-global --force ``` ```bash rrt agents install --dry-run ``` -------------------------------- ### rrt agents install examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Examples of how to use the 'rrt agents install' command with different target agents and options. ```text Usage: rrt agents [OPTIONS] Install bundled rrt user agents into one or more local or global agent directories. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── install Install bundled rrt user agents into agent directories. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt agents install --target claude-local $ rrt agents install --target claude-local --target codex-local $ rrt agents install --target copilot-local $ rrt agents install --target claude-global --force ``` ```text Usage: rrt agents install [OPTIONS] Install bundled .agent.md user agents into one or more local or global agent directories. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --target DEST Install target. Repeat to install into multiple locations: claude-local, claude-global, codex-local, codex-global, copilot-local, copilot-global, gemini-local, gemini-global. --dry-run Preview without writing files. --force Overwrite existing agent files. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt agents install --target claude-local $ rrt agents install --target claude-local --target codex-local $ rrt agents install --target gemini-local $ rrt agents install --target claude-global --force --dry-run $ rrt agents install --target copilot-global ``` -------------------------------- ### rrt hooks install examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Examples of how to use the 'rrt hooks install' command with different target surfaces and options. ```text rrt hooks install --target claude-local rrt hooks install --target claude-local --force rrt hooks install --dry-run ``` -------------------------------- ### rrt install command usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Provides the usage, arguments, options, and examples for the `rrt install` command. ```text Usage: rrt install [OPTIONS] Install one or more bundled rrt agent surfaces (skill, agents, hooks) into one or more local/global targets. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --surface SURFACE Surface to install. Repeat for multiple values. Defaults to all: skill, agents, hooks. --target DEST Install target. Repeat to install into multiple locations. Use --dry-run with no targets to inspect supported values. --dry-run Preview without writing files. --force Overwrite existing installed files. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt install --target claude-local $ rrt install --surface skill --target copilot-local $ rrt install --surface agents --surface hooks --target codex-global --dry-run ``` -------------------------------- ### rrt install examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/install.md Examples of how to use the rrt install command with various options. ```bash rrt install --target claude-local ``` ```bash rrt install --surface skill --target copilot-local ``` ```bash rrt install --surface agents --surface hooks --target codex-global --dry-run ``` ```bash rrt install --target gemini-local --target gemini-global --force ``` -------------------------------- ### rrt init Command Usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Shows the usage, arguments, options, and examples for the 'rrt init' command. ```text Usage: rrt init [OPTIONS] Generate a starter rrt configuration for the current repository or manifest. By default this writes .rrt.toml. Use --target to append or merge equivalent configuration into pyproject.toml, Cargo.toml, package.json, or a Go-oriented .rrt.toml template. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --dry-run Preview without writing files. --force Overwrite an existing .rrt.toml or package.json "rrt" key when writing those targets. --target FORMAT Where to write the rrt configuration. rrt-toml (default): write .rrt.toml; pyproject: append [tool.rrt] to pyproject.toml; cargo: append [package.metadata.rrt] to Cargo.toml; node: merge or replace the "rrt" key in package.json; go: write .rrt.toml with the recommended Go template. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt init --dry-run $ rrt init --target pyproject $ rrt init --target node --force $ rrt init --target go ``` -------------------------------- ### Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Examples of how to use the rrt tag command. ```bash rrt tag create rrt tag create --push --message "Production release v1.5.0" rrt tag create --prefix "" --force rrt tag check rrt tag check --strict --prefix "rel-" ``` -------------------------------- ### Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Examples of how to use the rrt workspace bump command. ```bash rrt workspace bump minor --packages api,sdk,docs rrt workspace bump 2.0.0 --packages ./packages/api,./packages/sdk rrt workspace bump patch --dry-run --packages api,sdk ``` -------------------------------- ### Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git_cmd.md Various examples of how to use the rrt git commands. ```bash rrt git status ``` ```bash rrt git commit "refresh help examples" ``` ```bash rrt git sync --dry-run ``` ```bash rrt git squash-local --base-ref origin/main "ship parser" ``` ```bash rrt git rebootstrap --yes-i-know-this-destroys-history --dry-run ``` -------------------------------- ### Install bundled rrt user workflow skills. Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/skill.md Examples of how to install rrt skills to various targets. ```bash rrt skill install --target copilot-local ``` ```bash rrt skill install --target claude-local --target codex-local ``` ```bash rrt skill install --target gemini-local ``` ```bash rrt skill install --target copilot-global --force --dry-run ``` -------------------------------- ### Common Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/tree.md Examples of how to use the `rrt tree` command with various options. ```bash rrt tree rrt tree --format ascii rrt tree --format markdown --max-depth 3 rrt tree --root src/repo_release_tools --dirs-only rrt tree --format markdown --inject README.md --anchor project-tree rrt tree --format markdown --inject README.md --anchor project-tree --dry-run ``` -------------------------------- ### Default CI setup Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/action.md Default CI setup for the GitHub Action. ```yaml - uses: Anselmoo/repo-release-tools@v1.7.0 with: check-changelog: "true" changelog-strategy: "auto" ``` -------------------------------- ### rrt hooks command usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Shows the general usage and available subcommands for the `rrt hooks` command, including installation. ```text Usage: rrt hooks [OPTIONS] Install bundled rrt user workflow hook scripts into one or more local hook directories and update the surface's hook registration JSON. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── install Install bundled rrt hook scripts into hook directories and register them. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt hooks install --target claude-local $ rrt hooks install --target codex-local $ rrt hooks install --target gemini-local $ rrt hooks install --target claude-local --force ``` -------------------------------- ### rrt hooks install command usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Details the usage, options, and examples for the `rrt hooks install` subcommand, which installs hook scripts and updates registration JSON. ```text Usage: rrt hooks install [OPTIONS] Install bundled rrt user workflow hook .py scripts into one or more local hook directories and update the native hook-registration JSON for that surface. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --target DEST Install target. Repeat to install into multiple locations: claude-local, claude-global, codex-local, codex-global, copilot-local, copilot-global, gemini-local, gemini-global. --dry-run Preview without writing files. --force Overwrite existing hook files. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt hooks install --target claude-local $ rrt hooks install --target claude-local --force --dry-run $ rrt hooks install --target codex-global $ rrt hooks install --target copilot-local ``` -------------------------------- ### rrt skill install usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/setup-tooling.md Usage information for the rrt skill install command. ```text Usage: rrt skill install [OPTIONS] Install the bundled rrt user skills into one or more local or global agent skill directories. Arguments Options -h, --help Show this message and exit. --target DEST Install target. Repeat to install into multiple locations: copilot-local, claude-local, codex-local, gemini-local, copilot-global, claude-global, codex-global, gemini-global. --dry-run Preview without writing files. --force Overwrite existing installed skill directories. Examples $ rrt skill install --target copilot-local $ rrt skill install --target claude-local --target codex-local $ rrt skill install --target copilot-global --force --dry-run $ rrt skill install --target gemini-global ``` -------------------------------- ### rrt release check example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Example of how to run the `rrt release check` command. ```bash rrt release check ``` -------------------------------- ### rrt action init command examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/ci-automation.md Examples of how to use the 'rrt action init' command with different options. ```bash rrt action init rrt action init --dry-run rrt action init --force ``` -------------------------------- ### Minimal Configuration Example Source: https://github.com/anselmoo/repo-release-tools/blob/main/README.md An example of a minimal TOML configuration for repo-release-tools, specifying release branch, changelog file, and changelog workflow. ```toml [tool.rrt] release_branch = "release/v{version}" changelog_file = "CHANGELOG.md" changelog_workflow = "incremental" # or "squash" [[tool.rrt.version_targets]] path = "pyproject.toml" kind = "pep621" ``` -------------------------------- ### UI layer import example Source: https://github.com/anselmoo/repo-release-tools/blob/main/CLAUDE.md Example of importing helpers from the canonical public rendering API. ```python from repo_release_tools.ui import ( DryRunPrinter, bold, error, info, rule, success, terminal_width, warning, ) ``` -------------------------------- ### rrt ci-version sync usage and examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Shows the usage, arguments, options, and examples for the `rrt ci-version sync` command. ```text Usage: rrt ci-version sync [OPTIONS] Compute the current GitHub Actions CI version and apply it to every configured ci_format target. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --group GROUP Version group to read/apply when multiple release groups are configured. --base VERSION Base version to compute from (default: read from first configured version target). --ref REF Git ref override (default: $GITHUB_REF). --ref-name NAME Git ref-name override (default: $GITHUB_REF_NAME). --run-id ID GitHub Actions run ID override (default: $GITHUB_RUN_ID). --run-attempt N GitHub Actions run-attempt override (default: $GITHUB_RUN_ATTEMPT). --dry-run Preview without writing changes. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt ci-version sync --dry-run $ rrt ci-version sync --group backend --ref refs/heads/main --run-id 42 --run-attempt 1 ``` -------------------------------- ### Activate lefthook hooks Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/agent-instructions.md Installs lefthook hooks for the repository. ```bash uv tool install repo-release-tools # installs rrt-hooks binary lefthook install # registers git hooks ``` -------------------------------- ### Example Branches Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/branch.md Illustrates the standard format with concrete examples of conventional branch names. ```text feat/add-config-discovery fix/handle-tag-workflows docs/split-readme-into-docs ``` -------------------------------- ### rrt ci-version apply usage and examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Shows the usage, arguments, options, and examples for the `rrt ci-version apply` command. ```text Usage: rrt ci-version apply [OPTIONS] Apply one explicit CI version string to every configured ci_format target in the selected version group. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Version string to apply (e.g. 0.2.0.dev12345601). ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --dry-run Preview without writing changes. --group GROUP Version group to update when multiple release groups are configured. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt ci-version apply 1.2.3.dev4201 $ rrt ci-version apply 1.2.3.dev4201 --group backend --dry-run ``` -------------------------------- ### Verification commands Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/agent-instructions.md Commands to verify the installation and linting of the repository. ```bash uv run pytest tests/test_hooks.py -x -q # fast unit tests uvx pre-commit run --all-files # lint (ruff, line-length 100) ``` -------------------------------- ### Activate pre-commit hooks Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/agent-instructions.md Installs pre-commit hooks for the repository. ```bash pre-commit install --install-hooks ``` -------------------------------- ### Artifacts Configuration Example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/repo-health.md Example of how to configure artifact targets in pyproject.toml. ```toml [[tool.rrt.artifact_targets]] path = "src/repo_release_tools/assets/badges/*.svg" description = "Platform badge SVG files" [[tool.rrt.artifact_targets]] path = "docs/assets/banner-*.png" description = "Banner PNG renders" ``` -------------------------------- ### Incremental workflow example for Lefthook Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/hooks.md Configuration example for Lefthook to manage hooks in an incremental Git workflow. ```yaml # lefthook.yml commit-msg: commands: rrt-update-unreleased: run: rrt-hooks update-unreleased --message-file {1} rrt-commit-subject: run: rrt-hooks commit-msg {1} pre-commit: commands: rrt-branch-name: run: rrt-hooks pre-commit pre-push: commands: rrt-changelog: run: rrt-hooks check-changelog --subject "$(git log -1 --format=%s)" --strategy unreleased ``` -------------------------------- ### Squash workflow example for Lefthook Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/hooks.md Configuration example for Lefthook to manage hooks in a squash merge Git workflow. ```yaml # lefthook.yml commit-msg: commands: rrt-commit-subject: run: rrt-hooks commit-msg {1} pre-commit: commands: rrt-branch-name: run: rrt-hooks pre-commit ``` -------------------------------- ### rrt branch new command example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Example of creating a new feature branch with a description. ```bash rrt branch new feat "add parser" ``` -------------------------------- ### rrt-release-check usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/hooks.md Examples of how to run the rrt-release-check command, both via pre-commit and directly. ```bash pre-commit run rrt-release-check --hook-stage manual # or directly: rrt release check ``` ```bash rrt-hooks check-dirty-tree ``` -------------------------------- ### Command Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/branch.md Demonstrates various ways to use the 'rrt branch' command for creating, renaming, and rescuing branches. ```bash rrt branch new feat "add parser" rrt branch new fix "repair config loader" --scope api rrt branch rename --type fix --scope api "fix config loader" rrt branch rescue feat "rescue work in progress" ``` -------------------------------- ### Build & test commands Source: https://github.com/anselmoo/repo-release-tools/blob/main/CLAUDE.md Commands for installing dependencies, running unit and integration tests, and linting the code. ```bash uv sync --all-groups # install deps (Python ≥ 3.12 required) uv run pytest -q -m "not runtime" # unit tests (fast) uv run pytest -q -m runtime tests/test_runtime_hybrid.py # integration tests uvx pre-commit run --all-files # lint with ruff (line-length 100) # Single test file uv run pytest tests/test_cli.py -xvs # Multi-Python matrix (3.12, 3.13, 3.14) — mirrors CI uvx --with tox-uv tox -p auto uvx --with tox-uv tox -e 3.14 -- tests/test_cli.py -xvs ``` -------------------------------- ### rrt env examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/repo-health.md Examples of how to use the 'rrt env' command to inspect the process environment and runtime context. ```bash rrt env rrt env --json ``` -------------------------------- ### rrt release notes Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Usage, options, and examples for the rrt release notes command. ```text Usage: rrt release notes [OPTIONS] Extract the current [Unreleased] section from the configured changelog and emit it as a formatted release body ready for GitHub, GitLab, or any markdown editor. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --format FORMAT Output format: md (default) or gh-release. --group GROUP Version group to read from when multiple groups are configured. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt release notes $ rrt release notes --format gh-release $ rrt release notes --format md > RELEASE_BODY.md ``` -------------------------------- ### Python Package CLI Usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/README.md Examples of using the repo-release-tools Python package via the CLI for local workflow automation. ```bash pip install repo-release-tools rrt init rrt branch new feat "add parser" rrt git commit "add parser" rrt git doctor rrt bump patch ``` ```bash uvx repo-release-tools branch new feat "add parser" ``` ```bash rrt skill install --target copilot-local rrt skill install --target claude-local --target codex-local rrt skill install --target codex-global --dry-run ``` -------------------------------- ### Bump command usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/version-release.md Usage details for the rrt bump command, including arguments, options, and examples. ```text Usage: rrt bump [OPTIONS] Bump project version using [tool.rrt] config. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── major | minor | patch | alpha | beta | rc | pre-release | calver | — bump kind or explicit version ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --calver-scheme SCHEME CalVer scheme to use when bump=calver (YYYY.MM | YYYY.MM.DD | YYYY.M.D). ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Release control ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── --dry-run Preview changes without writing to disk. --force Reset the release branch if it already exists. --no-commit Skip the git commit step. --no-verify Pass --no-verify to git commit (bypass pre-commit hooks). ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Content ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── --no-changelog Do not update the changelog file. --no-pin-sync Skip dependency pin synchronisation. --no-update Skip lockfile and generated-asset refresh steps. --include-maintenance Include maintenance commits in changelog. --changelog-mode MODE How to write changelog entries (auto | promote | generate). ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Git ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── --base-branch BRANCH Branch to release on. --group GROUP Version group to bump when multiple groups are configured. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt bump patch $ rrt bump minor --dry-run $ rrt bump 2.1.0 --no-changelog --no-commit $ rrt bump major --base-branch develop ``` -------------------------------- ### Example Session with MCP Server Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/mcp-server.md Demonstrates interactive commands and their corresponding rrt MCP calls within Claude Code. ```shell # From inside Claude Code with rrt MCP connected: "Show me the health dashboard" → calls rrt_health_dashboard — renders Metric cards, Ring, BarChart "What version is the project at?" → calls rrt_version or rrt_version_overview "Bump the patch version (dry run)" → calls rrt_bump with dry_run=True, shows preview "Open the init form" → calls rrt_init — renders target/dry_run/force form "Give me a custom chart of the lock file data" → LLM uses generate_prefab_ui + rrt://locks/{name} resources ``` -------------------------------- ### Install hook types Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/hooks.md Command to install the pre-commit hooks for both pre-commit and commit-msg stages. ```bash pre-commit install --hook-type pre-commit --hook-type commit-msg ``` -------------------------------- ### Artifacts Command Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/repo-health.md Examples of using the rrt artifacts command with different options. ```bash rrt artifacts --snapshot rrt artifacts --check rrt artifacts --check --strict rrt artifacts --list ``` -------------------------------- ### rrt config Command Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/repo-health.md Examples of using the rrt config command with different options. ```bash rrt config rrt config --raw rrt config --validate rrt config --schema > rrt-config.schema.json ``` -------------------------------- ### Install repo-release-tools with the [mcp] extra Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/mcp-server.md Command to add the [mcp] extra to your project using uv and verify the entry point. ```bash # Add the [mcp] extra to your project uv add "repo-release-tools[mcp]" # Verify the entry point works uv run rrt-mcp --help ``` -------------------------------- ### rrt branch rename Usage and Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Shows the usage and examples for renaming the current branch. ```text Usage: rrt branch rename [OPTIONS] Rename the current branch using conventional branch naming rules. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── New branch description words (replaces the current description). ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --type TYPE New conventional commit type (e.g. feat, fix, build). --scope SCOPE New scope to prefix the slug with. --no-scope Remove the scope from the new branch name (requires description words). --dry-run Preview the rename without touching git. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt branch new feat "add parser" $ rrt branch new fix "repair config loader" --scope api $ rrt branch rename --type fix --scope api "fix config loader" $ rrt branch rescue feat "rescue work in progress" ``` -------------------------------- ### rrt action init Usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/ci-automation.md Shows the usage, arguments, options, and examples for the `rrt action init` command. ```text Usage: rrt action init [OPTIONS] Write a starter .github/workflows/rrt.yml workflow for repo-release-tools CI. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --dry-run Preview without writing files. --force Overwrite an existing workflow file. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt action init $ rrt action init --dry-run $ rrt action init --force ``` -------------------------------- ### rrt branch rescue command example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Example of rescuing work in progress into a new feature branch. ```bash rrt branch rescue feat "rescue work in progress" ``` -------------------------------- ### Global help Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/rrt-cli.md Global help for rrt-cli ```bash $ rrt skill install --target copilot-local $ rrt @args.txt ``` -------------------------------- ### rrt docs generate examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/repo-health.md Examples of using the `rrt docs generate` command with different formats and options. ```bash rrt docs generate --format rich # colourised terminal preview rrt docs generate --format toml --dry-run # show lock without writing rrt docs check # exits 1 if lockfile is stale rrt docs api --format json # machine-readable API index ``` -------------------------------- ### Basic usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/init.md Initializes rrt configuration in a repository, with an option for a dry run. ```bash rrt init rrt init --dry-run ``` -------------------------------- ### rrt branch rescue Usage and Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Shows the usage and examples for rescuing commits onto a new branch. ```text Usage: rrt branch rescue [OPTIONS] TYPE Rescue commits onto a new branch and reset the current branch to a safe point. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── TYPE Short branch description. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --scope SCOPE Optional scope. --dry-run Preview without touching git. --since SHA Rescue commits since this SHA instead of origin/. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt branch new feat "add parser" $ rrt branch new fix "repair config loader" --scope api $ rrt branch rename --type fix --scope api "fix config loader" $ rrt branch rescue feat "rescue work in progress" ``` -------------------------------- ### rrt branch new Usage and Examples Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Shows the usage and examples for creating a new conventionally named branch. ```text Usage: rrt branch new [OPTIONS] TYPE Create a new conventionally named branch from a commit type, optional scope, and description. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── TYPE Short branch description. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --scope SCOPE Optional scope. --dry-run Preview without touching git. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt branch new feat "add parser" $ rrt branch new fix "repair config loader" --scope api $ rrt branch rename --type fix --scope api "fix config loader" $ rrt branch rescue feat "rescue work in progress" ``` -------------------------------- ### Basic usage of rrt config Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/config_cmd.md Demonstrates the basic usage of the 'rrt config' command, including an option to specify the output format. ```bash rrt config rrt config --format toml ``` -------------------------------- ### rrt git rebootstrap Usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Shows the usage, arguments, options, and examples for the `rrt git rebootstrap` command. ```text Usage: rrt git rebootstrap [OPTIONS] Back up the current .git directory, reinitialize the repository, and create a fresh history snapshot or empty bootstrap commit. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Arguments ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── -h, --help Show this message and exit. --yes-i-know-this-destroys-history Required confirmation for the destructive history reset. --allow-remote Allow rebootstrap even when remotes are configured. --hard-init Recreate .git and make only one empty initial commit, leaving files untracked. --branch BRANCH Initial branch name for the new repository. Defaults to the current branch. --message Commit message for the new initial commit. --empty-first Create an empty bootstrap commit before adding files. --empty-message Commit message for the optional empty bootstrap commit. --dry-run Preview without changing git. ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Examples ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── $ rrt git rebootstrap --yes-i-know-this-destroys-history --dry-run $ rrt git rebootstrap --yes-i-know-this-history --empty-first $ rrt git rebootstrap --yes-i-know-this-destroys-history --hard-init --branch main ``` -------------------------------- ### rrt branch rename command example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Example of renaming the current branch by changing its type, scope, and description. ```bash rrt branch rename --type fix --scope api "fix config loader" ``` -------------------------------- ### Basic usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/ci_version.md Prints the current project version to stdout. ```bash rrt ci-version ``` -------------------------------- ### rrt branch new command with scope example Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/git-workflow.md Example of creating a new fix branch with a scope and description. ```bash rrt branch new fix "repair config loader" --scope api ``` -------------------------------- ### Basic usage Source: https://github.com/anselmoo/repo-release-tools/blob/main/docs/commands/folder.md Demonstrates basic usage of the 'rrt folder' command for checking, scaffolding, and designing folder structures. ```bash rrt folder check --template python-package rrt folder scaffold --template docs-only --dry-run rrt folder design --name captured-template --root . ```