Using Version Control in Shakespeare

What is Version Control? What is Git?

Version control is like having a time machine for your code. It tracks every change you make to your project, allowing you to see what changed, when it changed, and who changed it. Git is the most popular version control system - think of it as a super-powered "undo" button that can save snapshots of your entire project at different points in time. If something breaks, you can easily go back to a working version. It also lets multiple people work on the same project without stepping on each other's toes.

1. Using Shakespeare's Built-in Version Control

Roll back to existing versions by clicking the … menu in the project chat pane → Rollback

Shakespeare rollback interface showing the three dots menu with rollback option

💡 Pro tip: Advanced Git Users

If you are an experienced git user, you can also speak to Shakespeare in the chat to give it git commands, or use git in the built-in terminal!

To access the terminal: click the code icon in the top right of the preview pane, then the terminal icon

Shakespeare terminal interface showing git commands being executed

2. Connecting to GitHub and GitLab

A benefit of connecting to GitHub or GitLab is that others can easily improve your projects, and you can easily sync your projects across devices by pushing and pulling.

GitHub

First log in to GitHub on Shakespeare: (settings → Git settings → connect GitHub)

https://shakespeare.diy/settings/git

Shakespeare settings page showing GitHub connection option

Then you have to create a new project in GitHub:https://github.com/new

(note: visibility MUST be public!)

Then copy the HTTPS clone URL (make sure you get the HTTPS and NOT the SSH!)

Example: https://github.com/marykatefain/fantastic-couscous.git

GitHub repository page showing how to copy the HTTPS clone URL

Then in Shakespeare click the … menu in the chat pane → Repository

Shakespeare chat pane showing the three dots menu with repository option

Then paste the git URL you copied and click "Save"

Then click "Push" to push your Shakespeare work to GitHub

Shakespeare repository settings showing push button to sync changes

GitLab

Same as GitHub, except you need to login with "Create a new token" first:

Create a new token here:https://gitlab.com/-/user_settings/personal_access_tokens

Set a long expiration for smoothest experience
Scope: read_repository, write_repository

GitLab personal access token creation page showing required scopes

Add the token to Shakespeare under settings → Git settings → GitLab:https://shakespeare.diy/settings/git

Shakespeare settings page showing GitLab token input field

Create new blank project in GitLab here:https://gitlab.com/projects/new#blank_project

Make it public, and Uncheck "Initialize repository with a README"

Copy the clone with HTTPS link (make sure it's not the SSH one!)

Ex. https://gitlab.com/marykatefain/testing.git

GitLab repository page showing how to copy the HTTPS clone URL

Add as the repository URL and click Push to sync your changes (same as GitHub)

3. Using Nostr Git

Under the repository settings, you can also push to Nostr to back up your repository without needing a GitLab or GitHub account (note: must be logged in to Nostr)