buntra
v0.1.0
Published
Bun-first CLI for creating projects from the bun-api-kit template.
Maintainers
Readme
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-apiShow help:
bunx buntra -h
bunx buntra create --helpWhat buntra Does
When you run create, buntra:
- Clones the
bun-api-kittemplate with git - Removes the template
.githistory - Sets
package.json.namebased on your target directory - Runs
bun install - 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 --helpContributing
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 buildLicense
This project is licensed under the MIT License. See LICENSE.
