documentation

Quickstart

Get up and running with Sturdy and start collaborating on code without Git.

Coding on Sturdy can begin as soon as you create a Sturdy account, and requires three steps:

  1. Install the client app so that your project files can be made available in a folder on your computer
  2. Create a blank codebase or import a Git repository
  3. Connect the client app to your newly created codebase

1. Install the Sturdy client

Sturdy allows real-time code collaboration and feedback for you and your team. This does not mean you need to code in the browser! The Sturdy sets up a directory on your computer that will be in sync with the cloud.

Go to instructions for or Linux or Windows

Install Sturdy for macOS

Install the Sturdy client with Homebrew

Alternatively, download Sturdy directly and add the binaries (sturdy and sturdy-sync) to your $PATH

curl -o sturdy.tar.gz https://getsturdy.com/client/sturdy-v0.7.3-darwin-amd64.tar.gz
tar xzvf sturdy.tar.gz
mv sturdy{,-sync} /usr/local/bin

Direct downloads

If you can't find your OS above (or are using arm64!), grab the download from one of these direct links.

2. Create a blank codebase or import an existing one

A codebase in Sturdy is just a collection of files that belong together, similar to a Git repository. In fact, Sturdy allows you to import an existing Git repository as well.

Creating a Sturdy codebase

3. Connect the client app

After creating or importing your code into Sturdy you will see a prompt to connect the codebase to your computer.

Connecting a Sturdy codebase to a computer
Connecting a Sturdy codebase to a computer. Note that the codebase name and ID will be different for you.

Copy and run the provided command in your terminal — this will initialize the codebase in a folder on your computer.

The last argument (in this example: my-first-codebase) is the path to the directory that Sturdy will create and setup your project in. If you want to setup Sturdy in another directory, change the last argument with the new path.

If this is the first codebase that you run sturdy init, you will be asked to authenticate yourself. Follow the on screen instructions.

Authenticating the Sturdy client
Authenticating the Sturdy client on first use.

After authenticating the client sets up the codebase in a folder on your computer.

Successful Sturdy client setup
Setup is successful. Note that the names and IDs will be different for you.

Next steps

After creating a codebase and connecting it to your computer you are ready to start coding. If you want to read more before getting started, here is more of our documentation.