Repo onboarding brief

Before you run it4 local tools

Everything here is checked on your machine when rote inspects the play. This page never learns what you have installed or which credentials you hold.

• ○
  shlocal tool

  Must be on your PATH when used. minimum version undeclared.

• ○
  greplocal tool

  Must be on your PATH when used. minimum version undeclared.

• ○
  findlocal tool

  Must be on your PATH when used. minimum version undeclared.

• ○
  wclocal tool

  Must be on your PATH when used. minimum version undeclared.

Inputs12, 1 required

rote asks for these before running and shows the defaults it will use.

• Repo pathrepo_path

  Absolute path to the repository checkout to read.

  requiredstringcustom value allowed
• Primary ci workflowprimary_ci_workflow

  Repo-relative CI file that SETUP and the VERIFY wiring check are sourced from (priority-1 rung of the SETUP ladder).

  optionalstringdefault .github/workflows/test.ymlcustom value allowed
• Secondary ci workflowssecondary_ci_workflows

  Repo-relative directory holding the remaining CI configs, read for lint and docs install lines.

  optionalstringdefault .github/workflowscustom value allowed
• Manifest filemanifest_file

  Repo-relative manifest. The manifest names the ecosystem; detect_ecosystem reports what is actually present so a caller can correct this.

  optionalstringdefault pyproject.tomlcustom value allowed
• Lockfilelockfile

  Repo-relative lockfile. The lockfile names the tool.

  optionalstringdefault uv.lockcustom value allowed
• Verify targetverify_target

  Repo-relative test file for the VERIFY step-2 wiring check. Empty means the wiring check renders as not determinable.

  optionalstringcustom value allowed
• Manifest anchorsmanifest_anchors

  ERE matching the manifest lines the brief cites. Defaults target pyproject/uv; override per ecosystem.

  optionalstringdefault ^name = |^build-backend|^requires-python|^\[project\.scripts\]|^\[tool\.pytest\]|^minversion|^filterwarnings|^timeout = |error-on-warning|^version = \{ source|^\[dependency-groups\]custom value allowed
• Ci anchorsci_anchors

  ERE matching the CI lines that carry install commands, run commands and gates.

  optionalstringdefault run: |install|sync|test|coverage|fail-under|python-versioncustom value allowed
• Entry point filesentry_point_files

  Space-separated repo-relative files searched for entry-point definitions. Empty means the stage renders as not determinable.

  optionalstringcustom value allowed
• Entry point anchorsentry_point_anchors

  ERE matching entry-point definitions across common languages.

  optionalstringdefault ^__version__|^__all__|^class |^def main|^app = |^func main|^module\.exports|^export defaultcustom value allowed
• Runner scripts dirrunner_scripts_dir

  Repo-relative directory of runner scripts read verbatim with line numbers.

  optionalstringdefault scriptscustom value allowed
• Toolchain probetoolchain_probe

  Space-separated executables probed for --version. Absent tools degrade to available:false, never a failure.

  optionalstringdefault uv python3 node cargo gocustom value allowed

What it changes