Files
docs/cli-docs/index.md
T
bircni 31cd47a65c docs: shorten the gt guides
Cover what users need to get going and leave the details to
gt <command> --help and gt help.

Signed-off-by: bircni <[email protected]>
2026-10-22 18:34:04 +02:00

1.0 KiB

sidebar_position, slug
sidebar_position slug
1 /

Gitea CLI

gt 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.

  2. Log in:

    gt auth login
    
  3. Run commands in a clone of a repository on that instance, or select one with --repo:

    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.