CLI

Start your new project with a single command.

✔ All prerequisites satisfied.
ℹ Configuring web app...
✔ API installed.
✔ Billing setup created.
✔ Emails configuration done.
ℹ Configuring mobile app...
✔ Authentication set up.
✔ Published to stores.
ℹ Configuring browser extension...
✔ Themes installed.
✔ Connected with web app.
✔ Project initialization completed.

To help you get started with TurboStarter as quickly as possible, we've developed a CLI that enables you to create a new project (with all the configuration) in seconds.

The CLI is a set of commands that will help you create a new project, generate code, and manage your project efficiently.

Currently, the following actions are available:

  • Starting a new project - Generate starter code for your project with all necessary configurations in place (billing, database, emails, etc.)
  • Updating existing project - Pull the latest upstream changes into your TurboStarter repository

The CLI is in beta, and we're actively working on adding more commands and actions.

Installation

You can run commands without installing globally:

npx @turbostarter/cli@latest <command>

Or install globally and run:

npm install -g @turbostarter/cli

turbostarter <command>

You can also display help for it or check the actual version using --help or -v flags.

Starting a new project

Use the new command to initialize configuration and dependencies for a new project.

turbostarter new

You will be asked a few questions to configure your project:

 All prerequisites satisfied, let's start! 🚀

? What do you want to ship? ›
    ◉   Web app
    ◉   Mobile app
    ◯   Browser extension
? Enter your project name. ›
? Configure all providers now? ›
    Yes, configure now (recommended)
    No, just let me ship, now!

Creating a new TurboStarter project in ...

✔ Repository successfully pulled!
✔ Git successfully configured!
✔ Dependencies successfully installed!
✔ Services successfully started!

🎉 You can now get started. Open the project and just ship it! 🎉

Problems? https://turbostarter.dev/docs

It will create a new project, configure providers, install dependencies and start required services in development mode.

Updating existing project

Use the project update command to pull the latest upstream changes into your TurboStarter repository.

turbostarter project update

Before updating, the CLI validates that:

  • You are running the command from a TurboStarter project root
  • Your git working tree is clean
  • Your upstream remote points to turbostarter/core

Then it fetches upstream changes and merges upstream/main into your current branch. If conflicts occur, it prints the conflicting files with next steps.

How is this guide?

Last updated on

On this page

Ship your startup everywhere. In minutes.Get TurboStarter