Create Rasengan CLI

The easiest way to get started with Rasengan.js is by using create-rasengan. This CLI tool enables you to quickly start building a new Rasengan.js project — frontend, Futon, Rasengan Server, or a full-stack monorepo — with everything set up for you.

Usage

You can create a new project just by running one of the following commands:

You'll then be prompted to name your project and choose what kind of project to create:

- What would you like to name your project?
- What kind of project would you like to create?

If you choose frontend (the default), you'll be asked further:

- Which language would you like to use for your project?
- Which template would you like to use?
- Do you want to enable file-based routing?

futon, server, and monorepo currently ship a single TypeScript "blank" variant each, so no further prompts are asked for those kinds.

Once you've answered the prompts, a new project is created and copied into place — dependencies aren't installed automatically, so cd into the folder and run your package manager's install command, then npm run dev.

Options

You can also pass the following options to the create-rasengan command instead of answering prompts interactively:

project name

npx create-rasengan@latest my-app

kind (--kind)

--kind selects the project kind, skipping the interactive prompt. One of frontend, futon, server, or monorepo.

npx create-rasengan@latest my-app --kind futon

template (--template, frontend kind only)

--template selects a frontend template directly: blank, tailwind, or shadcn.

npx create-rasengan@latest my-app --kind frontend --template tailwind

skip questions (-y or --yes)

-y stands for yes — the CLI takes all default answers (frontend, TypeScript, blank template, file-based routing) without prompting.

npx create-rasengan@latest my-app -y

beta (--beta or --experimental)

--beta scaffolds the project with the latest beta version of the rasengan dependency itself (not the CLI). This only affects the frontend kind's rasengan dependency — it has no effect for futon/server/monorepo kinds, which pin their own package versions directly. If no beta version is currently available, this option has no effect.

npx create-rasengan@latest my-app --beta

git (--git)

--git initializes a git repository and creates the first commit after the project has been generated.

npx create-rasengan@latest my-app --git

language (--language, frontend kind only)

--language selects typescript or javascript directly.

npx create-rasengan@latest my-app --language typescript

The default language is typescript.

chidori (--chidori)

--chidori scaffolds a documentation website using Chidori instead of any of the four project kinds above — it's a separate, standalone template.

npx create-rasengan@latest my-app --chidori

Why use create-rasengan?

create-rasengan lets you create a new Rasengan.js project — frontend or backend — within seconds. It's officially maintained by the creators of Rasengan.js, and includes a number of benefits:

• Interactive Experience: Running npx create-rasengan@latest launches an interactive experience that guides you through setting up a project.
• Direct use: You don't need to install the CLI globally before using it.
• One tool, four project kinds: The same CLI scaffolds a frontend app, a standalone Futon service, a full Rasengan Server backend, or a monorepo combining a frontend and a backend.

Community

Join the Rasengan.js community to get support, ask questions, and share your projects:

• GitHub Discussions

  – Ask questions and share ideas.

• X (Twitter)

  – Stay updated with the latest news.

• Linkedin

  – Follow the company page.

Let's build something amazing with Rasengan.js! 🚀

License

This package is MIT licensed.