Skip to content

calvindotsg/template-typescript-cli

Repository files navigation

{{TOOL_NAME}}

npm version CI license

{{TOOL_DESCRIPTION}}

Using this template? See TEMPLATE.md for setup instructions, including how to run scripts/init.sh to replace all placeholders with your project's values.

Features

  • Feature one
  • Feature two
  • Feature three

Install

Run directly without installing:

npx {{TOOL_NAME}} run

Or install globally:

npm install -g {{TOOL_NAME}}
pnpm add -g {{TOOL_NAME}}

Usage

# Main command
{{TOOL_NAME}} run --input hello

# Dry run (preview without changes)
{{TOOL_NAME}} run --dry-run

# Verbose logging
{{TOOL_NAME}} run --verbose

# Machine-readable JSON output
{{TOOL_NAME}} run --json

Commands Reference

Command Purpose
pnpm build Compile TypeScript
pnpm check Lint with Biome
pnpm test Run test suite
pnpm test:cov Run tests with coverage (75% threshold)
pnpm test:watch Run tests in watch mode
pnpm format Auto-format source files

Exit Codes

Code Meaning
0 Success
1 Invalid input

Contributing

See CONTRIBUTING.md for development setup, code style, and commit conventions.

License

MIT — see LICENSE.

About

TypeScript CLI template — commander, Biome, Vitest, release-please, npm OIDC publish

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Contributors