Getting started

Quickstart

Create an account, push your first repository and open a pull request.

1. Create an account

Open sign up and choose a username, email address and password, or choose Sync with GitHub to sign up with GitHub. Open the link in the verification email: you need a verified address to create repositories.

2. Install the CLI and sign in

The cafe CLI handles sign-in and Git credentials for you. It needs Bun 1.2 or newer.

sh
1bun install -g @gitcafe/cli
2cafe auth login
3cafe auth http setup

cafe auth login opens your browser to approve the sign-in; cafe auth http setup lets Git use that login for HTTPS. To use SSH instead, add an SSH key. See Git access for both.

3. Create a repository

sh
1cafe repo create my-app --private

Or open /new in the browser; see create a repository.

4. Push your code

From your project directory:

sh
1git init -b main
2git add .
3git commit -m "First commit"
4git remote add origin https://git.cafe/<you>/my-app
5git push -u origin main

5. Open a pull request

sh
1git switch -c add-readme
2echo "# my-app" > README.md
3git add README.md
4git commit -m "Add a README"
5git push -u origin add-readme
6cafe pr create --title "Add a README"

Open the pull request on GitCafe to review and merge it.

Next steps

Read as MarkdownGitCafe documentation
Documentation