feat: add CLI scaffolding tool and templates for new projects #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Implement scaffolding script to create new CLI projects - Add README and CHECKLIST templates for new CLIs - Update package.json with new scaffold command
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a CLI scaffolding workflow so new CLI entrypoints can be created consistently with shared patterns, documentation, and guidance.
Changes:
- Update
tsconfig.jsonto typecheck the newscripts/scaffolding script andtemplates/source files. - Add a
cli-basictemplate (TypeScript entrypoint, README, checklist) that follows existing logger/parseArgs/Zod conventions. - Add a
scaffold:clipackage script and updateAGENTS.mdwith instructions and a rule to standardize new CLI creation.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
tsconfig.json |
Expands the TypeScript include set to cover scripts/ and templates/, ensuring the scaffold script and template entrypoint are typechecked. |
templates/cli-basic/main.ts |
Provides a minimal CLI entrypoint template wired to Logger, parseArgs, and Zod, matching patterns used in existing CLIs. |
templates/cli-basic/README.md |
Supplies a template README describing how to run the generated CLI, its arguments, and output location. |
templates/cli-basic/CHECKLIST.md |
Adds a post-scaffold checklist guiding follow-up steps, structure, and pre-commit checks for new CLIs. |
scripts/scaffold-cli.ts |
Implements the CLI scaffolding logic (name validation, target directory checks, placeholder substitution, and file generation) based on the cli-basic template. |
package.json |
Registers the scaffold:cli script that runs the scaffolding tool via node:tsx. |
AGENTS.md |
Documents how to use pnpm scaffold:cli and establishes a rule to use the scaffold for all new CLIs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Change placeholders from double underscores to single underscores - Ensure consistency across scaffolded CLI files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Introduce a new CLI scaffolding tool that simplifies the creation of new CLI projects. This feature includes a script for generating project templates, along with README and checklist files to guide users through the setup process. The changes affect the
scripts/,templates/, andpackage.jsonfiles, enhancing the developer experience by providing a structured approach to project initialization.Implemented a scaffolding script in
scripts/scaffold-cli.ts.Added templates for README and checklist in
templates/cli-basic/.Updated
package.jsonto include a new command for scaffolding.How to test
Run
pnpm scaffold:cli -- --name=my-cli --description="What it does"to create a new CLI project.Verify that the new project structure is created under
src/cli/my-cli/.Check that the generated files contain the correct placeholders and instructions.
Security review
Secrets / env vars: not changed.
Auth / session: not changed.
Network / API calls: not changed.
Data handling / PII: not changed.
Dependencies: not changed.
No security-impacting changes identified.
No new dependencies and no network calls.
No env var changes and no auth/session logic touched.