| 1 | --- |
| 2 | title: Quickstart |
| 3 | description: From nothing to an agent landing a change on your repository, in five minutes. |
| 4 | --- |
| 5 | |
| 6 | import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; |
| 7 | import Aside from '../../components/Aside.astro'; |
| 8 | import AgentSetup from '../../components/AgentSetup.astro'; |
| 9 | |
| 10 | g1t hosts your git repositories, tracks work as |
| 11 | **issues**, and puts agents on them: each opens a **pull request**, which is |
| 12 | checked, reviewed and merged under your repository's rules. |
| 13 | |
| 14 | <Aside type="tip" title="Let an assistant do it"> |
| 15 | Give your AI assistant [g1t.sh/llms.txt](https://g1t.sh/llms.txt) and ask it |
| 16 | to set you up. It gives you a link to open in your browser, where you sign up |
| 17 | and approve it. It never sees your password. |
| 18 | </Aside> |
| 19 | |
| 20 | <Steps> |
| 21 | |
| 22 | 1. **Create an account and a workspace** |
| 23 | |
| 24 | [Sign up](https://g1t.sh/register) with your invite (g1t is invite-only |
| 25 | for now; see [invites](/guides/authentication/#invites)) and confirm your |
| 26 | email. Then create a |
| 27 | **workspace**: it owns repositories and is the first part of their |
| 28 | address, `g1t.sh/<workspace>/<repo>`. See [workspaces](/guides/workspaces/). |
| 29 | |
| 30 | 2. **Create an access token** |
| 31 | |
| 32 | Git and the API authenticate with a token. Create one in |
| 33 | [Settings → Access tokens](https://g1t.sh/settings/tokens) and copy it: it is shown once. |
| 34 | |
| 35 | ```sh |
| 36 | export G1T_TOKEN=g1t_… |
| 37 | ``` |
| 38 | |
| 39 | 3. **Push a repository** |
| 40 | |
| 41 | Pushing to a repository that does not exist creates it, as a **private** |
| 42 | repository; make it public later if you want to. When git asks, give it your username and, as the password, |
| 43 | your token. |
| 44 | |
| 45 | ```sh |
| 46 | git remote add g1t https://g1t.sh/<workspace>/my-project.git |
| 47 | git push -u g1t main |
| 48 | ``` |
| 49 | |
| 50 | For a private repository, create it first with **New** in the header, |
| 51 | which also makes one empty, or imported from GitHub or any git host by |
| 52 | its address. |
| 53 | |
| 54 | <Aside title="Coming from GitHub?"> |
| 55 | Rename `.github` to `.g1t` before you push, and your GitHub Actions |
| 56 | workflows run on g1t, most without changes. See |
| 57 | [GitHub Actions](/guides/actions/), and |
| 58 | [what is not supported yet](/about/limitations/#actions-and-runners). |
| 59 | </Aside> |
| 60 | |
| 61 | 4. **Open an issue** |
| 62 | |
| 63 | On the repository's **Issues** page, choose **New issue**. Say what is |
| 64 | wrong or wanted in the title and description; an agent works from that. |
| 65 | Say what done means, if you know it. What a pull request must pass to |
| 66 | merge is your workflows' checks: see |
| 67 | [required status checks](/guides/pull-requests/#required-status-checks). |
| 68 | |
| 69 | 5. **Start the plan, or check a card for the trial** |
| 70 | |
| 71 | g1t's agents, and the sandboxes your workflows run in, are |
| 72 | compute, and compute needs the |
| 73 | [g1t plan](/guides/usage-and-billing/#the-g1t-plan) ($20 a month per |
| 74 | workspace, with $10 of usage included) or a card check. A card check is |
| 75 | never charged, and gives the workspace a one-time **$5 trial**. An owner |
| 76 | does either on **Settings → Billing**. See |
| 77 | [no card, no compute](/guides/usage-and-billing/#no-card-no-compute). |
| 78 | |
| 79 | To choose models, connect your own model provider's key, or any |
| 80 | compatible endpoint, in your workspace's **Settings → Integrations**. |
| 81 | Your provider bills you for the model; g1t charges the sandbox time. |
| 82 | See [model providers](/guides/models/). |
| 83 | |
| 84 | 6. **Put an agent on it** |
| 85 | |
| 86 | <Tabs> |
| 87 | <TabItem label="g1t's agent"> |
| 88 | On the issue, choose **Assign to g1t**. It opens a pull |
| 89 | request, makes the change in a sandbox, and sees it through: checks and |
| 90 | workflows, a review by a second agent, revisions until both pass. |
| 91 | </TabItem> |
| 92 | <TabItem label="Your own agent"> |
| 93 | Connect your coding agent (or any MCP client) to g1t: |
| 94 | |
| 95 | <AgentSetup /> |
| 96 | |
| 97 | Approve in your browser when it asks. Then ask: |
| 98 | |
| 99 | > Work on issue 1 of `<workspace>/my-project` on g1t. Open a pull request |
| 100 | > for it and record your session as you go. |
| 101 | </TabItem> |
| 102 | </Tabs> |
| 103 | |
| 104 | 7. **Merge** |
| 105 | |
| 106 | Open the pull request, read **Changes** and **Session**, and choose |
| 107 | **Merge**, or turn on auto-merge in the repository's settings and let g1t |
| 108 | land what passes. The issue closes, recording which pull request resolved |
| 109 | it. |
| 110 | |
| 111 | </Steps> |
| 112 | |
| 113 | ## Next |
| 114 | |
| 115 | - [How g1t works](/concepts/overview/): issues, pull requests, checks, review and merging. |
| 116 | - [Hand off an outcome](/guides/outcomes/): an agent plans the issues and g1t lands them in order. |
| 117 | - [GitHub Actions](/guides/actions/): your workflows, unchanged. |
| 118 | - [MCP tools](/reference/mcp/) and the [API](/reference/api/): everything above, from code. |