Skip to content
githome

Quick start

go from zero to pushing code in 5 minutes

Run githome

The fastest path is Docker:

docker run -d --name githome \
  -p 3000:3000 \
  -v githome-data:/var/lib/githome \
  -e GITHOME_HTML_BASE_URL=http://localhost:3000 \
  -e GITHOME_WEB_ENABLED=true \
  ghcr.io/tamnd/githome:latest

Wait for it to be ready:

curl http://localhost:3000/readyz
# → OK

If you prefer a binary:

# macOS (Apple Silicon)
curl -L https://github.com/tamnd/githome/releases/latest/download/githome_darwin_arm64.tar.gz | tar xz
./githome serve

Create your first account

Open http://localhost:3000 and register. The first account becomes the admin.

Generate a personal access token: Settings > Developer settings > Personal access tokens > Generate new token. Copy it, you will use it in the next step.

Connect the gh CLI

echo YOUR_TOKEN | gh auth login --hostname localhost:3000 --with-token
gh auth status --hostname localhost:3000

Create a repo and push:

gh repo create myproject --private --hostname localhost:3000
cd myproject
git init && echo "# myproject" > README.md
git add . && git commit -m "init"
git push -u origin main

Clone and push without gh CLI

git clone http://localhost:3000/alice/myrepo.git

For password-less access, store your credentials once:

git config --global credential.helper store
echo "machine localhost login alice password YOUR_TOKEN" >> ~/.netrc

What is next

2 min read