Repository navigation
[v1.0] Add a five-minute starter template #244
Description
Goal
Reduce the time from installation to a production-shaped CLI without adding a hidden framework-specific scaffold dependency.
Scope
- Maintain a copyable starter project based on
examples/minimal_cli. - Cover packaging, tests, lifecycle options, human output, actionable errors, and safe customization points.
- Provide a five-minute clean-environment tutorial and installed-consumer validation.
- Keep the starter consumer-neutral and avoid imposing heavy optional dependencies.
- Defer an interactive
base-cli initgenerator until post-1.0 consumer feedback stabilizes the template contract.
Acceptance criteria
- A new user can copy, install, test, and invoke a working CLI in five minutes.
- The starter passes the same structural, packaging, and consumer gates as the framework examples.
- The starter explains which files are safe to customize and keeps the public
base_clifacade as the integration boundary. - Starter updates are tested against the current base-cli release line.
Project fields
- Status: In Review
- Priority: P1
- Area: CLI
- Initiative: Adoption Polish
- Size: M
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
codeforester commentedon Sep 12, 2026
2026-09-12 repository review refresh
The framework has multiple installable examples, but the flagship demo has no smallest-project handoff yet (base-cli-demo#20). Prioritize a tested minimal template with an explicit attachment point and a working production error test; prove that an unfamiliar Click author can use it before growing an interactive scaffold generator.
Validated against current main (
7faf347a5b90969e169c88f3ac18e7202d142dd0). This review files and scopes work; it does not claim implementation or authorize release/admin changes.docs: add five-minute starter template (#244)
[-][v1.0] Add a starter template and base-cli init workflow[/-][+][v1.0] Add a five-minute starter template[/+]codeforester commentedon Oct 22, 2026
Implementation evidence is in PR #465: #465
The maintained
examples/minimal_cliproject is now the copyable five-minute starter, with safe customization guidance, a current pre-1.0 dependency window, installed-consumer tests, and an actionable missing-option error test. An interactivebase-cli initgenerator is explicitly deferred until post-1.0 consumer feedback. The issue remains In Review pending review/merge.codeforester commentedon Oct 23, 2026
Review follow-up completed in PR #465. The starter now has one editable install flow with a dev extra, correct Windows activation syntax, and a shared base-cli release-line requirement enforced across all four examples. Commits: 5017feb, 1584a65. Full pytest and example/documentation validators pass locally; all review threads are resolved.