Skip to content

pimatis/buntra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

buntra

buntra

Bun-first CLI for bootstrapping API projects from the bun-api-kit template.

Scaffold fast, remove template git history, install dependencies, and update them to the latest versions.

Overview

buntra is a small CLI focused on one job: creating a ready-to-run Bun API project with a clean handoff from template to real project.

It clones the upstream template, removes the template .git directory, updates the generated package.json name, runs bun install, and then runs bun update --latest.

Requirements

  • Bun >= 1.3.0
  • git

Quick Start

Create a project in the current directory:

bunx buntra create .

Create a project in a new directory:

bunx buntra create my-api

Show help:

bunx buntra -h
bunx buntra create --help

What buntra Does

When you run create, buntra:

  1. Clones the bun-api-kit template with git
  2. Removes the template .git history
  3. Sets package.json.name based on your target directory
  4. Runs bun install
  5. Runs bun update --latest

If the target directory is not empty, buntra asks for confirmation before merging files and warns when existing paths will be overwritten.

Command Reference

create

Bootstrap a project from the template.

bunx buntra create <project-name|.>

Examples:

bunx buntra create .
bunx buntra create my-service

-h, --help

Show global help or command-specific help.

bunx buntra -h
bunx buntra create --help

Contributing

Contributions are welcome through issues and pull requests.

Before opening a pull request, make sure the project still passes its publish checks:

bun run check
bun run build

License

This project is licensed under the MIT License. See LICENSE.

About

Bun-first CLI for scaffolding bun-api-kit projects.

Resources

License

Stars

Watchers

Forks

Contributors