create-susee
v0.1.2
Published
Scaffold a new TypeScript library project pre-configured with susee.
Maintainers
Readme
create-susee
Scaffold a new TypeScript/JavaScript library project pre-configured with susee.
create-susee is an interactive CLI tool that bootstraps a new library project with everything you need to start building and bundling with susee — a high-performance, TypeScript-first library bundler powered by oxc.
Quick Start
Use your favorite package manager to run the scaffolder:
# npm
npm create susee@latest
# yarn
yarn create susee
# pnpm
pnpm create susee
# bun
bun create suseeThe CLI will walk you through a few prompts and generate a ready-to-build project in seconds.
What It Generates
Based on your choices, create-susee creates the following structure:
my-susee-lib/
├── src/
│ └── index.ts # Public entry point (with a sample greet function)
├── susee.config.ts # Susee build configuration
├── tsconfig.json # TypeScript compiler options
├── package.json # Scripts, dependencies, and metadata
├── .gitignore
├── README.md
├── AGENTS.md # (optional) Agent context file
├── .oxlintrc.json # (optional, if "oxc" linter is chosen)
├── .oxfmtrc.json # (optional, if "oxc" linter is chosen)
└── biome.json # (optional, if "biome" linter is chosen)After generation, dependencies are automatically installed using the detected package manager.
CLI Prompts
| Prompt | Description | Default |
| ---------------- | -------------------------------------------------------------------------- | -------------- |
| Project name | Name of the project (used as the directory name and package name) | my-susee-lib |
| TypeScript? | Whether to set up a TypeScript project | Yes |
| AGENT.md? | Whether to generate an AGENTS.md file with project context for AI agents | No |
| Linter | Choose between biome, oxc, or none (interactive arrow-key menu) | biome |
Features
- 📦 Zero-config bundling — Generates a
susee.config.tswith sensible defaults for ESM output and TypeScript declarations. - 🔧 Linter support — Pick between Biome or Oxc (oxlint + oxfmt), or skip linting entirely.
- 🤖 AGENTS.md support — Optionally generate an
AGENTS.mdfile that provides AI coding agents with project context, tech stack details, and structure overview. - 📦 Package manager detection — Automatically detects whether you're using npm, yarn, pnpm, or bun and uses it for dependency installation.
- 🚀 Latest versions — Fetches the latest published versions of susee, TypeScript, and linter packages from the npm registry at scaffold time.
Generated Scripts
The scaffolded package.json includes the following scripts (depending on your linter choice):
All projects:
{
"build": "susee build",
"check": "susee check",
}With Biome:
{
"lint": "biome check src --write",
"fmt": "biome format --write",
}With Oxc:
{
"lint": "oxlint",
"lint:fix": "oxlint --fix",
"fmt": "oxfmt",
"fmt:check": "oxfmt --check",
}Build
To build the create-susee CLI itself:
npm install
npm run buildThis uses susee build to compile the TypeScript source in src/ into dist/.
