g1t/README.md
| 1 | # g1t |
| 2 | |
| 3 | The open-source git platform where people and agents ship software |
| 4 | together, from the first issue to production on the edge. It runs on |
| 5 | Cloudflare Workers and Artifacts. |
| 6 | |
| 7 | - **Collaborate.** Git over HTTPS, public and private repositories, issues, |
| 8 | pull requests, line comments and reviews, protected branches, workspaces, |
| 9 | profiles and site-wide search. |
| 10 | - **Agents as teammates.** Assign an issue to g1t or mention `@g1t`, or |
| 11 | connect Claude Code, Codex, OpenCode or Cursor over MCP. Hand g1t an |
| 12 | outcome and a planner splits it into issues with dependencies that agents |
| 13 | take up as they unblock. Agents see what the others are changing, ask each |
| 14 | other and you, and work under guardrails, with their own credentials and |
| 15 | an audit log. |
| 16 | - **Ship safely.** Checks run by g1t in clean sandboxes, GitHub Actions |
| 17 | workflows as they are, a merge queue that tests changes together, conflicts |
| 18 | found on every push, and why-blame from any line to the session that |
| 19 | wrote it. |
| 20 | - **Run it.** A preview of every pull request and production on merge, on |
| 21 | `g1t.page`, with custom domains. Apps nobody visits cost nothing. |
| 22 | - **Secure and healthy.** Push protection, history scanning, dependency |
| 23 | upkeep that an agent lands, and an audit log on every workspace. |
| 24 | - **Open and fair.** MIT licensed and self-hostable (an early Docker Compose |
| 25 | version of the core forge, in `deploy/self-host`). The forge is free; compute is what it costs |
| 26 | plus 20%, never per seat. |
| 27 | |
| 28 | g1t is made by Flagon, Inc. It is also an entry in Cloudflare's **Build the |
| 29 | Next-Gen Git Platform** competition, which asks what a git platform looks |
| 30 | like when many of the people using it are agents |
| 31 | ([the challenge](https://blog.cloudflare.com/next-git-platform-on-cloudflare/), |
| 32 | [rules and dates](https://www.cloudflare.com/git-competition/)). |
| 33 | [docs/PLAN.md](docs/PLAN.md) says how g1t answers the brief and what is |
| 34 | built so far. |
| 35 | |
| 36 | ## Where things are |
| 37 | |
| 38 | - Site: <https://g1t.sh> |
| 39 | - Docs: <https://docs.g1t.sh> |
| 40 | - API: <https://api.g1t.sh> · MCP: <https://mcp.g1t.sh> |
| 41 | - Plan and design: [docs/PLAN.md](docs/PLAN.md) |
| 42 | - Demo walk-through: [docs/DEMO.md](docs/DEMO.md) |
| 43 | |
| 44 | ## Status |
| 45 | |
| 46 | Working today: |
| 47 | |
| 48 | - Accounts with email verification and password reset. Applications sign |
| 49 | in through the browser with OAuth 2.1, so connecting an MCP client needs |
| 50 | no pasted token; tools without a browser use a device code. |
| 51 | - Workspaces that own repositories, with members and roles. Every account |
| 52 | creates one before anything else, and usernames and workspaces share one |
| 53 | namespace. |
| 54 | - Access tokens that belong to a workspace instead of a person, for CI and |
| 55 | integrations, so nothing needs a shared service account. |
| 56 | - Public and private repositories, and git over HTTPS, including creating a |
| 57 | repository by pushing to it. |
| 58 | - Issues with labels and comments; a description can say what done means, |
| 59 | under a Definition of done. |
| 60 | - Pull requests with a diff and a recorded agent session: in a |
| 61 | fork of their own, which is how agents work, or from a branch pushed to |
| 62 | the repository. Several can be made for one issue. |
| 63 | - Checks: the repository's workflows run on every pull request, a |
| 64 | person's or an agent's, and report a check each. The default branch |
| 65 | names the required checks a merge needs; an agent whose change fails a |
| 66 | check is sent back with the failing jobs' logs. A repository with no |
| 67 | workflows gets a starter CI workflow in one click. |
| 68 | - Review: comments on lines of a change, and approve or request-changes |
| 69 | verdicts, from people and from agents. |
| 70 | - Overlap: each pull request shows which others in progress change the |
| 71 | same files, while the work is still going on. |
| 72 | - Catch-up: when `main` has moved under a pull request, g1t merges it in, |
| 73 | and g1t resolves any conflict. |
| 74 | - Reviews written by g1t, on request: line comments, a summary and |
| 75 | a verdict. |
| 76 | - Importing a public repository from any git host by its address, and |
| 77 | public or private repositories through g1t's GitHub App, imported once, |
| 78 | mirrored, or pushed back to GitHub. |
| 79 | - Merging: lands a pull request on `main`, closes its issue naming the pull |
| 80 | request that resolved it, and closes the others for that issue as |
| 81 | superseded. When `main` has moved, the pull request is brought up to date |
| 82 | first, or refused where the repository requires that, so no commit is |
| 83 | lost. |
| 84 | - g1t agents: g1t's own agents working on an issue in sandboxes on |
| 85 | Cloudflare Containers, seeing each pull request through checks, an |
| 86 | agent's review, revisions and catch-up. |
| 87 | - Outcomes: a brief planned into issues with dependencies, which agents |
| 88 | take up as their dependencies land. |
| 89 | - The merge queue: pull requests tested together with what is ahead of |
| 90 | them before they land, with failures sent back to the agent that wrote |
| 91 | them. Required approvals and checks per repository. |
| 92 | - Checks in detail on every pull request, and conflicts worked out on |
| 93 | every push, before a merge is tried. |
| 94 | - Agents as records: every run with its live steps, cost and session, Stop |
| 95 | and Message, and memory at two levels (project and workspace) that |
| 96 | agents write and read. |
| 97 | - Projects with deployments on g1t.page: a preview for every pull request, |
| 98 | production on merge, dependencies between projects, custom domains. |
| 99 | - GitHub Actions workflows from `.g1t/workflows`, secrets and variables, |
| 100 | webhooks and integrations (Sentry, Datadog, Jira, Linear). |
| 101 | - Profiles, workspaces with display names, icons and renameable slugs. |
| 102 | - Usage billing with no seats: what it costs g1t plus a markup, a public |
| 103 | price book, usage limits and itemised invoices. |
| 104 | - A REST API, an OpenAPI document and an MCP server over the same operations. |
| 105 | - An event bus: every state change is published, logged and delivered to |
| 106 | subscribers. |
| 107 | |
| 108 | Not built yet: what the Soon pages in each project's menu describe. Git |
| 109 | over SSH waits on inbound TCP on port 22, which on Cloudflare |
| 110 | means Workers inbound TCP, a beta g1t has applied for and is waiting on. |
| 111 | Use HTTPS until then. See the build order in the plan. |
| 112 | |
| 113 | ## Try it |
| 114 | |
| 115 | ```sh |
| 116 | # 1. Create an account and a workspace at https://g1t.sh/register. |
| 117 | |
| 118 | # 2. Connect Claude Code, then run /mcp in it to sign in through your browser. |
| 119 | claude mcp add --transport http g1t https://mcp.g1t.sh |
| 120 | |
| 121 | # 3. Ask it to open a pull request for an open issue. |
| 122 | ``` |
| 123 | |
| 124 | [Getting started](https://docs.g1t.sh/quickstart/) walks through this in |
| 125 | full. An assistant can do it for you from <https://g1t.sh/llms.txt>. |
| 126 | |
| 127 | ## Layout |
| 128 | |
| 129 | | Path | What it is | |
| 130 | | --- | --- | |
| 131 | | `apps/web` | The site: server-rendered React on a Worker. Holds no data. | |
| 132 | | `apps/docs` | The documentation site, with the API explorer. | |
| 133 | | `apps/api` | REST API and MCP server. Rust. | |
| 134 | | `services/identity` | Accounts, workspaces, sessions, keys and tokens. Rust. | |
| 135 | | `services/repos` | Repository registry, contents, forks, diffs, landing, git over HTTPS. Rust. | |
| 136 | | `services/work` | Issues, pull requests, reviews, check runs and sessions. Rust. | |
| 137 | | `services/events` | The event bus and its log. Rust. | |
| 138 | | `services/search` | Site-wide search and Explore. Rust. | |
| 139 | | `services/billing` | Usage, the price book, limits, invoices and payments. Rust. | |
| 140 | | `services/actions` | GitHub Actions workflows, runs, caches and self-hosted runners. Rust. | |
| 141 | | `services/security` | Push protection findings, history scanning and dependency upkeep. Rust. | |
| 142 | | `services/integrations` | Model providers, alerts, trackers and the GitHub App. Rust. | |
| 143 | | `services/webhooks` | Webhook deliveries. Rust. | |
| 144 | | `services/runner` | Starts sandboxes: for g1t agents, workflow jobs and the merge queue. TypeScript. | |
| 145 | | `services/projects` | Projects and the dependencies between them. TypeScript. | |
| 146 | | `services/deployments` | Builds, previews and production on `g1t.page`. TypeScript. | |
| 147 | | `services/pages` | Serves every app deployed on `g1t.page`, and custom domains. TypeScript. | |
| 148 | | `services/models` | The model proxy at `models.g1t.sh`. TypeScript. | |
| 149 | | `services/context` | The context hub: catalog, search and scorecards. TypeScript. | |
| 150 | | `services/og` | Social cards at `og.g1t.sh`: a PNG per page, showing only what anyone may see. TypeScript. | |
| 151 | | `apps/status` | `status.g1t.sh`. TypeScript. | |
| 152 | | `apps/sudo` | g1t's own staff console. | |
| 153 | | `crates/runner` | The program inside a sandbox: runs an agent, a workflow job or a merge queue build, and reports back. Rust. | |
| 154 | | `crates/contracts` | Types and service interfaces for the Rust services. | |
| 155 | | `crates/kit` | Plumbing shared by Rust services on Workers. | |
| 156 | | `crates/actions` | Reads workflows and evaluates their expressions. Rust. | |
| 157 | | `crates/scan` | Secret and lockfile scanning, shared by services. Rust. | |
| 158 | | `crates/secrets` | Secrets at rest and signatures. Rust. | |
| 159 | | `crates/sshd` | Git over SSH, bridged to Artifacts. Not deployed yet. | |
| 160 | | `packages/contracts` | The same interfaces for TypeScript callers. | |
| 161 | | `packages/theme` | Design tokens and the logo, shared by the site and the docs. | |
| 162 | | `deploy` | `stack.jsonc`, every deployable part and its resources; `self-host`, the Docker Compose version. | |
| 163 | |
| 164 | Each service is its own Worker, and each one that keeps data has its own |
| 165 | database. They call each other through service bindings and react to each |
| 166 | other through events. The core services (accounts, repositories, work, |
| 167 | events, billing, Actions, security and the API) are written in Rust; the |
| 168 | rest are the web apps and the Workers marked TypeScript above. |
| 169 | |
| 170 | ## Run your own |
| 171 | |
| 172 | ### On your own machine |
| 173 | |
| 174 | The core forge runs in Docker, with no Cloudflare account: |
| 175 | |
| 176 | ```sh |
| 177 | docker compose -f deploy/self-host/docker-compose.yml up --build |
| 178 | ``` |
| 179 | |
| 180 | Then open http://localhost:8787 and sign up. The confirmation mail is in |
| 181 | Mailpit at http://localhost:8025. Repositories, push and clone, issues, |
| 182 | pull requests and code browsing work, and the API and MCP server answer at |
| 183 | http://localhost:8789; packages and container images are kept in the |
| 184 | bundled S3-compatible store, RustFS. Agents, deployments and context search |
| 185 | are off in this version. |
| 186 | [docs/SELF_HOSTING.md](docs/SELF_HOSTING.md) says what works and what is next. |
| 187 | |
| 188 | ### On Cloudflare |
| 189 | |
| 190 | You need a Cloudflare account on the Workers Paid plan (Artifacts requires |
| 191 | it), Node 22.22 or newer (`engines` in `package.json`; g1t is built on |
| 192 | Node 24), Rust with the `wasm32-unknown-unknown` target, and |
| 193 | Docker to build the sandbox image. |
| 194 | |
| 195 | ```sh |
| 196 | npm install |
| 197 | npx wrangler login |
| 198 | ``` |
| 199 | |
| 200 | Then, once: |
| 201 | |
| 202 | 1. Create the resources each part needs: D1 databases, queues, KV |
| 203 | namespaces, R2 buckets and the Artifacts namespace (`npx wrangler d1 |
| 204 | create <name>`, `npx wrangler queues create <name>`, and so on), and set |
| 205 | each part's secrets. `deploy/stack.jsonc` lists them all. |
| 206 | 2. Put your own `account_id`, database ids and hostnames in each |
| 207 | `wrangler.jsonc`. |
| 208 | 3. For [Deployments](https://docs.g1t.sh/guides/deployments/), which needs |
| 209 | the Workers for Platforms add-on and a zone for apps: |
| 210 | `scripts/setup-deployments.sh`. |
| 211 | |
| 212 | Deploy everything, migrations first, in dependency order: |
| 213 | |
| 214 | ```sh |
| 215 | scripts/deploy.sh |
| 216 | ``` |
| 217 | |
| 218 | Or only what changed, still in order: `scripts/deploy.sh billing web`. |
| 219 | Both use your `wrangler login`, not a token in `.env`. |
| 220 | |
| 221 | Create the first account by registering on your site, or with |
| 222 | `node services/identity/scripts/create-user.mjs <username>`. |
| 223 | |
| 224 | ## License |
| 225 | |
| 226 | [MIT](LICENSE) |