◆ docs

Getting started

Create an account, make your first repository, and get your code onto rickub in a few minutes.

Head to Sign up and create an account with your email address and a password. Pick a handle — your unique name on rickub. Your handle is the first segment of every URL you own, for example rickub.com/your-handle/your-repo.

After you sign up we send a verification email. Click the link in it to confirm your address — you need a verified email before you can create repositories.

Note

Handles are a single shared namespace for users and organizations, exactly like on GitHub — rickub.com/{handle} is either a person or an org.

The rickub dashboard after signing in, listing your repositories and organizations — Your dashboard lists the repositories and organizations you can access.

Create your first repository

Click New repository (or go to /new). Give it a name, an optional description, and choose whether it's public or private. You can create the repository under your own handle or under any organization where you have permission.

The create-repository form with name, description and visibility fields — Creating a repository: name it, describe it, and choose its visibility.

Push existing code

Already have a local project? Point it at your new rickub repository and push:

cd my-project
git init                      # if it isn't a git repo yet
git add .
git commit -m "Initial commit"
git branch -M main
git remote add origin https://git.rickub.com/your-handle/my-project.git
git push -u origin main

Note

Note the host: the repository's web page lives at rickub.com/your-handle/my-project, but git traffic (clone, fetch, push) is served from git.rickub.com. The repository page shows the exact clone URLs to copy.

Clone a repository

Over HTTPS (with a token)

Cloning over HTTPS uses your handle as the username and a personal access token as the password. Create a token under Settings → Access tokens, then:

git clone https://git.rickub.com/your-handle/my-project.git
# Username: your-handle
# Password: paste your personal access token

Tip

Let git remember the token with a credential helper: git config --global credential.helper store (or osxkeychain on macOS) so you only paste it once.

Over SSH (with a key)

Add your public SSH key under Settings → SSH keys, then clone with the SSH remote. rickub's SSH front-end listens on port 2222, so use the ssh:// URL form, which carries the port:

git clone ssh://git@rickub.com:2222/your-handle/my-project.git

Note

Don't have a key yet? Generate one with ssh-keygen -t ed25519 -C "you@example.com" and add the contents of ~/.ssh/id_ed25519.pub.

Next steps