Skip to content
Download

Quick Start

This assumes Wyrm is installed and you’re signed in. Shortcuts are for macOS.

1. Open a repository

Section titled “1. Open a repository”

After you sign in, Wyrm shows Open a repository to get started with three buttons:

  • Open… (⌘O): a folder you already have, Git or jj.
  • Clone… (⌘⇧O): copy a repository from GitHub, GitLab or any Git URL to your Mac.
  • New repository… (⌘⇧N): start a new repository in an empty or existing folder.

Your existing Git repository

Section titled “Your existing Git repository”

Open a plain Git folder and Wyrm asks first, with Git Repository Detected: “This is a Git repository. Wyrmflow will initialize jujutsu alongside Git so you can use both tools.” Click Open Repository.

What that does:

  • It creates a .jj/ folder next to .git/. Your .git/, branches and history are kept as they are.
  • .jj/ hides itself from git status with its own ignore file. Your project’s .gitignore isn’t changed, so there is nothing new to commit.
  • Nothing changes for your teammates. They keep using Git; what you push is ordinary Git commits and branches.
  • You can still run git in the same folder. Expect git status to report a detached HEAD: that’s how jj and Git share a folder.

2. Read the log

Section titled “2. Read the log”

The log is your history as a graph, newest at the top. Each row is a commit: its change ID, its description, author and age. The row with the green halo is @, your working copy. In jj the files you’re editing are always a commit, so there is no separate “uncommitted changes” area.

Click a row to see its changes in the revision pane. Use ↑ / ↓ to move through the log, and G to jump back to @. More in Log Graph.

3. Make a change

Section titled “3. Make a change”

Edit a file in your editor and save. Wyrm picks the change up into @; the row updates and the file appears in its changes. There’s nothing to stage.

4. Describe it

Section titled “4. Describe it”

Select @ and type a message into Describe this change… in the revision pane, then press ↩ to save it. D opens the same thing as a dialog, Edit Description.

When the change is done, press ⌘↩ (or click Finish change). That runs jj commit: it keeps your message on this commit and starts a new, empty @ on top for the next piece of work. To start a new commit on top of any other commit, select it and press N (or ⌘N, New child).

5. Push it, with a preview

Section titled “5. Push it, with a preview”

Git remotes push bookmarks (jj’s name for branches).

  1. Select the commit you just finished and press B (Create bookmark…). Give it a name such as fix-typo.
  2. Click Push in the top bar. Nothing is sent yet: Wyrm opens Push to origin and lists each bookmark with what will happen to it: New, Update, Delete, or Diverged if your bookmark and the remote one have gone separate ways.
  3. Read it, then click Push 1 bookmark.

The preview compares against the last fetch, so click Fetch first if teammates may have pushed. Details in Push Preview. To open a pull request from the bookmark, see Pull & merge requests.

6. Undo

Section titled “6. Undo”

Click Undo in the top bar, or press ⌘Z. In jj, undo works on operations: a describe, a rebase, an abandon. Undo doesn’t take back commits that are already on the remote. Each undo steps back one more, and ⌘⇧Z redoes. The Operations panel in the icon rail lists every operation, and you can restore the repository to any of them. See Undo & the operation log.

Next steps

Section titled “Next steps”