Files
ai-agent-harness/sources/project-types/scaffold-cli.md

1.2 KiB

Scaffold CLI Project Rules

  • Treat both the CLI interface and the generated project structure as public contracts.
  • Preserve existing command names, flags, defaults, prompts, exit behavior, and generated paths unless a breaking change is explicitly approved.
  • Keep generation deterministic for the same input and template version.
  • Do not embed credentials, user-specific absolute paths, local machine state, or uncommitted source files in templates.
  • Never overwrite a non-empty target directory unless the user explicitly selected and authorized the supported force behavior.
  • Validate template changes by generating a project in a newly created, disposable directory.
  • Validate the generated project with its own type-check, build, or compile commands when practical.
  • Inspect generated output for unresolved placeholders, accidental secrets, invalid encodings, machine-specific paths, and unexpected files.
  • Keep README usage, CLI help, templates, and implementation synchronized.
  • Preserve operation when the central Agent Harness is not installed.
  • Generate the committed Agent Harness file set by default for every new project.
  • Updating embedded harness templates does not authorize publishing the CLI package.