CLI

Kyrin comes with a built-in CLI to help you create new projects quickly.

Installation

npm install -g kyrin

Create a New Project

Interactive Mode

kyrin spawn

This will prompt you to:

1. Enter your project name
2. Select a database (SQLite, PostgreSQL, MySQL, or None)

Command Mode

You can also pass arguments directly:

kyrin spawn my-project --db=sqlite

Available database options:

• sqlite - SQLite (default, great for development)
• postgres - PostgreSQL
• mysql - MySQL
• none - Skip database setup

Without Global Installation

If you don't have Kyrin installed globally, you can use:

bunx kyrin spawn my-project

Or from within the Kyrin project directory:

bun run spawn my-project

What's Created

After running kyrin spawn, you'll get:

my-project/
├── src/
│   └── index.ts      # Your server entry point
├── .gitignore
├── package.json
└── tsconfig.json

Running Your Project

cd my-project
bun run dev

Your server will start at http://localhost:3000.