mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
bircni
31cd47a65c
Cover what users need to get going and leave the details to gt <command> --help and gt help. Signed-off-by: bircni <[email protected]>
40 lines
1.0 KiB
Markdown
40 lines
1.0 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
slug: /
|
|
---
|
|
|
|
# Gitea CLI
|
|
|
|
[gt](https://gitea.com/gitea/cli) is the official command line client for Gitea. It works
|
|
with repositories, issues, pull requests, releases, Actions and the other resources of a
|
|
Gitea instance, from a terminal or a script.
|
|
|
|
:::info Development version
|
|
These pages describe builds from the `main` branch of gitea/cli.
|
|
:::
|
|
|
|
gt needs Gitea 28 or later, and Git for the commands that clone, check out or push.
|
|
|
|
## Getting started
|
|
|
|
1. [Install gt](installation.md).
|
|
2. [Log in](authentication.md):
|
|
|
|
```bash
|
|
gt auth login
|
|
```
|
|
|
|
3. Run commands in a clone of a repository on that instance, or select one with `--repo`:
|
|
|
|
```bash
|
|
gt issue list --label bug
|
|
gt pr checkout 13
|
|
gt issue view 42 --repo gitea.com/gitea/cli
|
|
```
|
|
|
|
`gt doctor` checks your setup and suggests a fix for each problem it finds.
|
|
|
|
Every command documents itself with `--help`. `gt help environment`, `gt help formatting`
|
|
and `gt help exit-codes` cover global flags and environment variables, JSON output, and
|
|
exit codes.
|