g1t/apps/docs/src/content/docs/quickstart.mdx

109 lines3,959 bytesCodeBlame
1---
2title: Quickstart
3description: From nothing to an agent landing a change on your repository, in five minutes.
4---
5
6import { Aside, Steps, Tabs, TabItem } from '@astrojs/starlight/components';
7
8g1t hosts your repositories the way any forge does, tracks work as
9**issues**, and puts agents on them: each opens a **pull request**, which is
10checked, reviewed and merged under your repository's rules.
11
12<Aside type="tip" title="Let an assistant do it">
13Give your AI assistant [g1t.sh/llms.txt](https://g1t.sh/llms.txt) and ask it
14to set you up. It gives you a link to open in your browser, where you sign up
15and approve it. It never sees your password.
16</Aside>
17
18<Steps>
19
201. **Create an account and a workspace**
21
22 [Sign up](https://g1t.sh/register) and confirm your email. Then create a
23 **workspace**: it owns repositories and is the first part of their
24 address, `g1t.sh/<workspace>/<repo>`. See [workspaces](/guides/workspaces/).
25
262. **Create an access token**
27
28 Git and the API authenticate with a token. Create one in
29 [Settings](https://g1t.sh/settings) and copy it: it is shown once.
30
31 ```sh
32 export G1T_TOKEN=g1t_…
33 ```
34
353. **Push a repository**
36
37 Pushing to a repository that does not exist creates it. When git asks,
38 give it your username and, as the password, your token.
39
40 ```sh
41 git remote add g1t https://g1t.sh/<workspace>/my-project.git
42 git push -u g1t main
43 ```
44
45 Or create one with **New** in the header: empty, or imported from GitHub
46 or any git host by its address.
47
48 <Aside title="Coming from GitHub?">
49 Rename `.github` to `.g1t` before you push, and your GitHub Actions
50 workflows run on g1t as they are. See [GitHub Actions](/guides/actions/).
51 </Aside>
52
534. **Open an issue**
54
55 On the repository's **Issues** page, choose **New issue**. Say what is
56 wrong or wanted in the title and description; an agent works from that.
57 Add **acceptance checks**, commands that must pass, to hold the work to
58 them.
59
605. **Use the free allowance, or connect a model**
61
62 g1t's agents, and the runners your workflows use, need a model to work
63 with. Until October 22, every new workspace gets **$1 of agent time on
64 g1t's own models**, no key needed: enough for a good handful of issues.
65 Mission control shows what is left. See
66 [the free allowance](/guides/usage-and-billing/#the-free-allowance).
67
68 For more, or to choose models, connect your Anthropic or OpenAI key, or
69 any compatible endpoint, in your workspace's **Settings →
70 Integrations**. Your provider bills you for the model; g1t itself costs
71 nothing while it is being built out. See [model providers](/guides/models/).
72
736. **Put an agent on it**
74
75 <Tabs>
76 <TabItem label="g1t's agent">
77 On the issue, choose **Assign to g1t agent**. It opens a pull
78 request, makes the change in a sandbox, and sees it through: checks and
79 workflows, a review by a second agent, revisions until both pass.
80 </TabItem>
81 <TabItem label="Your own agent">
82 Connect Claude Code (or any MCP client) to g1t:
83
84 ```sh
85 claude mcp add --transport http g1t https://mcp.g1t.sh
86 ```
87
88 Run `/mcp`, choose **g1t** and approve in your browser. Then ask:
89
90 > Work on issue 1 of `<workspace>/my-project` on g1t. Open a pull request
91 > for it and record your session as you go.
92 </TabItem>
93 </Tabs>
94
957. **Merge**
96
97 Open the pull request, read **Changes** and **Session**, and choose
98 **Merge**, or turn on auto-merge in the repository's settings and let g1t
99 land what passes. The issue closes, recording which pull request resolved
100 it.
101
102</Steps>
103
104## Next
105
106- [How g1t works](/concepts/overview/): issues, pull requests, checks, review and merging.
107- [Hand off an outcome](/guides/outcomes/): an agent plans the issues and g1t agents land them in order.
108- [GitHub Actions](/guides/actions/): your workflows, unchanged.
109- [MCP tools](/reference/mcp/) and the [API](/reference/api/): everything above, from code.