​
Use the CLI

Run the super-starter init command to help you get started with SuperStarter as quickly as possible. This is the way we recommend:

Terminal
npx super-starter@latest init

You will be prompted for the project name and package manager.

Terminal
$ npx super-starter@latest init

┌  Let's start a SuperStarter project!
│
◇  What is your project named?
│  my-app
│
◇  Which package manager would you like to use?
│  pnpm
│
◇  Project initialized successfully!

This will create a new directory with your project name and clone the repo into it. It will run a setup script to install dependencies and copy .env files. You can read more about environment variables here.

​
Git clone

Clone the repository using the following command:

Terminal
git clone git@github.com:focusapps/SuperStarter/

If your SSH key isn’t set up, use HTTPS instead:

Terminal
git clone https://github.com/focusapps/SuperStarter/

Use HTTPS for all commands if not using SSH

If you are not using SSH, ensure you switch to HTTPS for all Git commands, not just the clone command.

​
Git remote

After cloning the repository, remove the original origin remote:

Terminal
git remote rm origin

Add the upstream remote pointing to the original repository to pull updates:

Terminal
git remote add upstream https://github.com/focusapps/SuperStarter/

Once you have your own repository set up, add your repository as the origin:

Terminal
git remote add origin <your-repo-url>

​
Commit and push

After making changes to your project, you can commit and push them to your repository:

Terminal
git commit -m "Your commit message"
git push origin main

and push them to your remote repository with:

Terminal
git push origin main

Check out the Git remote documentation for more information.