https://github.com/deepfriedmind/bun-ts-cli-starter

A starter kit for developing CLI apps using Bun/TypeScript and other useful tools.
https://github.com/deepfriedmind/bun-ts-cli-starter

boilerplate bun cli typescript

Last synced: about 1 month ago
JSON representation

A starter kit for developing CLI apps using Bun/TypeScript and other useful tools.

• Host: GitHub
• URL: https://github.com/deepfriedmind/bun-ts-cli-starter
• Owner: deepfriedmind
• License: mit
• Created: 2025-08-02T22:10:59.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2026-01-23T16:15:48.000Z (5 months ago)
• Last Synced: 2026-01-24T07:17:32.568Z (5 months ago)
• Topics: boilerplate, bun, cli, typescript
• Language: TypeScript
• Homepage:
• Size: 599 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Bun TS CLI Starter

![GitHub Release](https://img.shields.io/github/v/release/deepfriedmind/bun-ts-cli-starter)

![GitHub License](https://img.shields.io/github/license/deepfriedmind/bun-ts-cli-starter)

![Node version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fdeepfriedmind%2Fbun-ts-cli-starter%2Frefs%2Fheads%2Fmain%2Fpackage.json&query=engines.node&logo=nodedotjs&label=Runs%20in%20Node)

![Bun version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fdeepfriedmind%2Fbun-ts-cli-starter%2Frefs%2Fheads%2Fmain%2Fpackage.json&query=devEngines.runtime.version&logo=bun&label=Developed+with+bun)

![GitHub top language](https://img.shields.io/github/languages/top/deepfriedmind/bun-ts-cli-starter)

[![Checked with Biome](https://img.shields.io/badge/Checked_with-Biome-60a5fa?logo=biome)](https://biomejs.dev)

![Header](header.svg)

My starter kit for developing CLI apps using:

- [Bun](https://bun.com/) (and its built-in [test runner](https://bun.com/docs/cli/test))

- [TypeScript](https://www.typescriptlang.org/)

- [Commander.js](https://github.com/tj/commander.js)

- [Consola](https://github.com/unjs/consola)

- [figlet](https://github.com/patorjk/figlet.js)

- [gradient-string](https://github.com/bokub/gradient-string)

- [terminal-link](https://github.com/sindresorhus/terminal-link)

- [Biome](https://biomejs.dev/)

- [Ultracite](https://www.ultracite.ai/)

- [Knip](https://knip.dev/)

- [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks)

- [devmoji](https://github.com/folke/devmoji)

- [Release It!](https://github.com/release-it/release-it)

![screenshot](screenshot@2x.avif)

## Setup

```bash

# Clone the repository

mkdir 

git clone https://github.com/deepfriedmind/bun-ts-cli-starter.git 

cd 

# 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](https://bun.com/guides/runtime/vscode-debugger)

## Demo scripts

Render the logo in every available figlet font:

```bash

bun run demo:fonts

```

Render a single font across every horizontal layout:

```bash

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](LICENSE) file for details.

---