README.md

Bun TS CLI Starter

My starter kit for developing CLI apps using:

• Bun (and its built-in test runner)
• TypeScript
• Commander.js
• Consola
• figlet
• gradient-string
• terminal-link
• Biome
• Ultracite
• Knip
• simple-git-hooks
• devmoji
• Release It!

Setup

# Clone the repository
mkdir <new project name>
git clone https://github.com/deepfriedmind/bun-ts-cli-starter.git <new project name>
cd <new project name>

# Install dependencies
bun install

# Run the project entrypoint
bun start

# Build the project
bun run build

# Run tests
bun test

# Run tests with coverage
bun test --coverage

# Run all checks
bun run check

Debugging

See Debugging Bun with the VS Code extension

Demo scripts

Render the logo in every available figlet font:

bun run demo:fonts

Render a single font across every horizontal layout:

bun run demo:fonts -- --font "Standard"

This is a demo-only script and is not part of the main CLI.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Development guidelines

1. TypeScript: All code must be written in TypeScript
2. Testing: New features must include comprehensive tests
3. Documentation: Update README.md for new features
4. Code Style: Follow the existing code style and linting rules

License

This project is licensed under the MIT License - see the LICENSE file for details.

---