mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-04 09:15:33 +00:00
Adds a CLI product for gt (https://gitea.com/gitea/cli), set up like the runner, with short guides for installation, logging in, CI and scripting. Each command's details stay in gt <command> --help. Until the first release, the docs are served at /cli/; make cut-version PRODUCT=cli VERSION=0.1 adds the release series. Closes https://gitea.com/gitea/cli/issues/16 <!-- cloudflare-preview --> Preview: https://pr-603.docs-gitea-com.pages.dev --------- Co-authored-by: silverwind <[email protected]> Reviewed-on: https://gitea.com/gitea/docs/pulls/603 Reviewed-by: Lunny Xiao <[email protected]> Reviewed-by: silverwind <[email protected]>
38 lines
1.0 KiB
Markdown
38 lines
1.0 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
# Installation
|
|
|
|
gt is a single binary for Linux, macOS, Windows and FreeBSD.
|
|
|
|
## Install script
|
|
|
|
The install script downloads gt from [dl.gitea.com](https://dl.gitea.com/gitea-cli/),
|
|
verifies its checksum and installs it.
|
|
|
|
```bash
|
|
# Linux, macOS, FreeBSD
|
|
curl -fsSL https://gitea.com/gitea/cli/raw/branch/main/scripts/install.sh | sh
|
|
```
|
|
|
|
```powershell
|
|
# Windows
|
|
irm https://gitea.com/gitea/cli/raw/branch/main/scripts/install.ps1 | iex
|
|
```
|
|
|
|
Set `GITEA_CLI_VERSION` to install a specific version, or `nightly` for the latest build
|
|
of `main`.
|
|
|
|
## Other ways
|
|
|
|
- **Binaries:** download them from [dl.gitea.com/gitea-cli](https://dl.gitea.com/gitea-cli/).
|
|
- **Docker:** the [`gitea/gitea-cli`](https://hub.docker.com/r/gitea/gitea-cli) image runs
|
|
`gt` as its entry point.
|
|
- **Go:** `go install gitea.dev/cli/cmd/gt@latest`
|
|
|
|
## Shell completion and man pages
|
|
|
|
`gt completion <shell>` prints the completion script for bash, zsh, fish or PowerShell;
|
|
`gt completion <shell> --help` shows how to load it. `gt man` prints the manual.
|