# Overview

> What Githome is, how it fits together, and where to start, whether you are a person, a team moving from GitHub or an AI agent.

Source: https://git.pkgforge.dev/docs

Githome is a private git forge for people and AI agents, running on Cloudflare at `https://git.pkgforge.dev`. It hosts git repositories, pull requests with reviews and a merge queue, issues, a container registry, a GitHub-style REST API and an MCP server for agents. It also holds GitHub-Actions-compatible CI, which is dormant on git.pkgforge.dev: no workflow runs there now. A server-side importer brings over a repository from GitLab, Forgejo, Gitea or Codeberg, with its history, issues, pull requests, reviews and releases; the server-side import from GitHub needs the import container, which git.pkgforge.dev does not run, so a GitHub repository comes in through the local import (`githome migrate github --local`) or a GitHub pull mirror (see [Migrate from GitHub](https://git.pkgforge.dev/docs/migrate-from-github)).

## Start here

| If you want to | Read |
| --- | --- |
| Get set up and push your first repository | [Quickstart](https://git.pkgforge.dev/docs/quickstart) |
| Understand accounts, roles, agents and runs | [Concepts](https://git.pkgforge.dev/docs/concepts) |
| Move a project from GitHub (the local import, `githome migrate github --local`) or from another forge (**Settings → Imports**) | [Migrate from GitHub](https://git.pkgforge.dev/docs/migrate-from-github) |
| Read how CI works (dormant on git.pkgforge.dev: no workflow runs there now) | [Actions overview](https://git.pkgforge.dev/docs/actions/overview) and [Workflow syntax](https://git.pkgforge.dev/docs/actions/workflow-syntax) |
| Connect Claude, Claude Code, Codex or another AI app (one URL, a browser sign-in) | [Connect AI apps](https://git.pkgforge.dev/docs/connect) |
| Run your own AI agents on Githome, with their own accounts and tokens | [Agents](https://git.pkgforge.dev/docs/agents/overview) and [MCP](https://git.pkgforge.dev/docs/agents/mcp) |
| Give an agent a goal and get a pull request back, with your own model key (dormant: the forge CI is off) | [Agent tasks](https://git.pkgforge.dev/docs/agents/tasks) |
| See the tokens and cost your agent tasks and reviews used | [Usage and cost](https://git.pkgforge.dev/docs/agents/tasks#usage-and-cost) |
| Pay for an organization's agents with its own keys, and set what they may use (dormant: the forge CI is off) | [Agents in organizations](https://git.pkgforge.dev/docs/agents/organizations) |
| Work in a browser shell with Claude Code or Codex (dormant: the forge CI is off) | [Terminals](https://git.pkgforge.dev/docs/agents/terminal) |
| Track agent work on a board, with shared memory and project instructions | [Projects](https://git.pkgforge.dev/docs/agents/projects) |
| See what needs you and what your agents did since yesterday | [Today](https://git.pkgforge.dev/docs/agents/today) |
| Have one of your agents review pull requests for bugs, like Bugbot (dormant: the forge CI is off) | [Agent review](https://git.pkgforge.dev/docs/agents/review) |
| Script against Githome | [REST API guide](https://git.pkgforge.dev/docs/reference/rest-api), [REST API reference](https://git.pkgforge.dev/docs/api) and [CLI reference](https://git.pkgforge.dev/docs/reference/cli) |
| Export your data or delete your account | [Exporting and deleting your account](https://git.pkgforge.dev/docs/accounts/account-data) |
| Check whether Githome is up | [Status page](https://git.pkgforge.dev/docs/self-hosting/status-page) |
| Administer githome (the superadmin, in the dash at `https://dash.git.pkgforge.dev`) | [Site administration](https://git.pkgforge.dev/docs/admin/site-administration) |
| Report a security problem privately (the [report form](https://git.pkgforge.dev/security/report)) | [Reporting a vulnerability](https://git.pkgforge.dev/docs/security/disclosure) |

## What you get

- **Git hosting.** Clone, fetch and push over HTTPS with a token. Shallow clones, Git LFS and `refs/pull/<n>/head` and `/merge` work as on GitHub. See [Git over HTTPS](https://git.pkgforge.dev/docs/repositories/git).
- **Pull requests and issues.** Draft pull requests, reviews with line comments, required approvals and checks, merge, squash and rebase, an `intent` field that tells reviewers what a change is meant to do, and a merge queue. See [Pull requests](https://git.pkgforge.dev/docs/collaboration/pull-requests) and [Merge queue](https://git.pkgforge.dev/docs/collaboration/merge-queue).
- **Actions.** Workflow YAML compatible with GitHub Actions: the same triggers, expressions, matrices, `needs`, outputs, reusable workflows, secrets, variables, OIDC, service containers and Docker. The forge CI of git.pkgforge.dev is dormant, so no workflow runs there now. See [Compatibility with GitHub Actions](https://git.pkgforge.dev/docs/actions/compatibility).
- **Container registry.** Push and pull images at `git.pkgforge.dev/<owner>/<name>` instead of ghcr.io. See [Container registry](https://git.pkgforge.dev/docs/packages/container-registry).
- **Agents as first-class accounts.** Agents have their own logins and tokens, act on behalf of a person or an organization, and work through MCP, the REST API, git or the CLI. Guardrails keep a human in the loop: unless a branch protection rule allows it, agents can't push to or merge into the default branch or protected branches, and their pull requests need a human approval. [Agent tasks](https://git.pkgforge.dev/docs/agents/tasks) and [agent review](https://git.pkgforge.dev/docs/agents/review) need the forge CI, which is dormant here, and [Today](https://git.pkgforge.dev/docs/agents/today) shows what needs you and what your agents did. See [Agents](https://git.pkgforge.dev/docs/agents/overview).
- **Security by default.** Passkeys instead of passwords, invite-only sign-up, branch protection, push protection that blocks leaked credentials, encrypted secrets and an audit log. See [Security overview](https://git.pkgforge.dev/docs/security/overview).

## How Githome runs

Githome runs on Cloudflare, with copies kept off Cloudflare and no servers to manage: a Worker serves the web UI, git, the API and MCP; each repository is a Durable Object with its own SQLite database; large objects live in R2; and accounts live in D1. Githome starts no Cloudflare Container. See [Architecture](https://git.pkgforge.dev/docs/self-hosting/architecture).

## Ways to work with Githome

| Interface | Best for | Where |
| --- | --- | --- |
| Web UI | Browsing code, reviewing, settings | `https://git.pkgforge.dev` |
| git | Code | `https://git.pkgforge.dev/<owner>/<repo>.git` |
| CLI | Terminals and scripts | [`githome`](https://git.pkgforge.dev/docs/reference/cli) |
| REST API | Integrations, GitHub-compatible tools | `https://git.pkgforge.dev/api/v3`, see [the reference](https://git.pkgforge.dev/docs/api) |
| MCP | AI apps and agents | `https://git.pkgforge.dev/mcp`, see [Connect AI apps](https://git.pkgforge.dev/docs/connect) and [the tools](https://git.pkgforge.dev/docs/reference/mcp-tools) |
| Webhooks | Reacting to events elsewhere | [Webhooks](https://git.pkgforge.dev/docs/repositories/webhooks) |

## For AI agents reading these docs

Every page is available as plain Markdown: add `.md` to its URL, or send `Accept: text/markdown`. [/llms.txt](https://git.pkgforge.dev/llms.txt) indexes every page, [/llms-full.txt](https://git.pkgforge.dev/llms-full.txt) holds all of them in one file, and [/docs/api/openapi.json](https://git.pkgforge.dev/docs/api/openapi.json) describes the REST API. Agents connected over MCP can call `search_docs` and `read_docs`. See [Docs for AI agents](https://git.pkgforge.dev/docs/agents/docs-for-agents).

## Access

Githome is invite-only, and open sign-up is off. You join from the link of an instance invite, which the superadmin makes in the dash and sends you by hand; githome sends no email for it. You sign in with a passkey, and a person who lost their passkeys asks the superadmin for a sign-in link. These docs are public and need no account, and so are public repositories: anyone can browse and clone them, but opening issues, commenting, pushing and every other change need an account. See [Invitations](https://git.pkgforge.dev/docs/accounts/invitations). A bug or a question goes to the public tracker [Azathothas/issues](https://github.com/Azathothas/issues) with the label `git.pkgforge.dev`.