Get started
The welcome steps
The first time Puck starts, it walks through a few steps. Each one can be skipped and changed later in File > Options.
- Sign in to GitHub.com or GitHub Enterprise, to clone your repositories and work with pull requests. Puck works with any Git host without signing in.
- Import, shown only when GitHub Desktop is installed and lists repositories on this PC: brings those repositories into Puck, with your editor and shell choices.
- Git: the name and email your commits carry.
- Look: the theme (Dark, Light, or the system’s) and the row density.
- Tools: the editor and shell Puck opens repositories in.
- Repository: clone, add, or create your first repository.
Add a repository
| To | Use |
|---|---|
| Open a folder that is already a Git repository | File > Add local repository (Ctrl+O), or drop the folder on the window |
| Copy a repository from a server | File > Clone repository (Ctrl+Shift+O). Signed in, pick from your account’s repositories; otherwise paste the URL |
| Start a new repository | File > New repository (Ctrl+N), with a README, a .gitignore template, and a license if you want them |
From a terminal, puck open <folder> and puck clone <url> do the same (Windows: when Add puck to PATH was checked in Setup).
The window
- The top bar holds the current repository, worktree, and branch: click one to switch. The search box in the middle is the command palette (Ctrl+K): every menu command, your repositories, branches, and files.
- The rail on the left switches between Changes (Ctrl+1), History (Ctrl+2), Branches (Ctrl+3), Pull requests (Ctrl+4, for repositories on GitHub), Stashes (Ctrl+5), and Worktrees (Ctrl+6).
- The sync control at the top right fetches, pulls, pushes, or publishes, and shows how far ahead or behind the branch is.
- The menu shows when you press Alt or F10, or click the mark at the top left.
Next: Work with a repository.