Fork 0
Go to file
Renovate Bot 2f1ca85b25 chore(deps): update actions/checkout action to v4 (#588)
Co-authored-by: Renovate Bot <renovate-bot@gitea.com>
Co-committed-by: Renovate Bot <renovate-bot@gitea.com>
2023-09-25 03:39:40 +00:00
.devcontainer add devcontainer for tea (#582) 2023-09-08 15:24:36 +00:00
.gitea chore(deps): update actions/checkout action to v4 (#588) 2023-09-25 03:39:40 +00:00
cmd added migrate command (#587) 2023-09-11 06:27:48 +00:00
contrib Add command to install shell completion (#309) 2020-12-17 00:01:59 +08:00
docs added migrate command (#587) 2023-09-11 06:27:48 +00:00
modules bump to yaml.v3 2023-09-10 03:47:43 +00:00
.changelog.yml Changelog v0.6.0 (#289) 2020-12-14 20:33:54 +08:00
.dockerignore Makefile: add STATIC=true for static PIE builds (#349) 2021-09-24 00:01:07 +08:00
.gitignore Fix for go tools called from make (#568) 2023-08-21 22:01:15 +00:00
.goreleaser.checksum.sh Switch CI to Actions and use Goreleaser (#536) 2023-03-30 10:24:03 +08:00
.goreleaser.yaml ci: improve release process and test coverage (#553) 2023-05-04 11:58:15 +08:00
.revive.toml Fix CI: disable package-comments lint rule (#494) 2022-08-22 20:53:19 +08:00
CHANGELOG.md Changelog for v0.9.1 (#535) 2023-02-15 23:23:12 +01:00
CONTRIBUTING.md spdx (#581) 2023-09-08 01:40:02 +00:00
DCO init project 2018-09-03 14:43:00 +08:00
Dockerfile pie doesn't mesh with scratch image 2023-09-10 00:50:04 -04:00
FEATURE-COMPARISON.md Add feature comparison chart between forge CLIs (#294) 2020-12-15 12:59:49 +08:00
LICENSE init project 2018-09-03 14:43:00 +08:00
Makefile pie doesn't mesh with scratch image 2023-09-10 00:50:04 -04:00
README.md Update documentation about brew and some other misc (#590) 2023-09-15 02:12:50 +00:00
build.go spdx (#581) 2023-09-08 01:40:02 +00:00
demo.gif Proper help text & new README structure (#311) 2020-12-21 21:37:20 +08:00
devbox.json feat: devbox (#572) 2023-09-08 15:24:52 +00:00
devbox.lock feat: devbox (#572) 2023-09-08 15:24:52 +00:00
go.mod fix(deps): update module github.com/go-git/go-git/v5 to v5.9.0 (#589) 2023-09-13 18:52:54 +00:00
go.sum fix(deps): update module github.com/go-git/go-git/v5 to v5.9.0 (#589) 2023-09-13 18:52:54 +00:00
main.go spdx (#581) 2023-09-08 01:40:02 +00:00
renovate.json5 Configure Renovate (#573) 2023-09-07 23:08:07 +00:00


tea logo T E A

License: MIT Release Join the chat at https://img.shields.io/discord/322538954119184384.svg Go Report Card GoDoc

The official CLI for Gitea

demo gif

   tea - command line tool to interact with Gitea
   version 0.8.0-preview

   tea command [subcommand] [command options] [arguments...]

   tea is a productivity helper for Gitea. It can be used to manage most entities on
   one or multiple Gitea instances & provides local helpers like 'tea pr checkout'.
   tea tries to make use of context provided by the repository in $PWD if available.
   tea works best in a upstream/fork workflow, when the local main branch tracks the
   upstream repo. tea assumes that local git state is published on the remote before
   doing operations with tea.    Configuration is persisted in $XDG_CONFIG_HOME/tea.

   help, h  Shows a list of commands or help for one command
     issues, issue, i                  List, create and update issues
     pulls, pull, pr                   Manage and checkout pull requests
     labels, label                     Manage issue labels
     milestones, milestone, ms         List and create milestones
     releases, release, r              Manage releases
     times, time, t                    Operate on tracked times of a repository's issues & pulls
     organizations, organization, org  List, create, delete organizations
     repos, repo                       Show repository details
     comment, c                        Add a comment to an issue / pr
     open, o                         Open something of the repository in web browser
     notifications, notification, n  Show notifications
     clone, C                        Clone a repository locally
     logins, login                  Log in to a Gitea server
     logout                         Log out from a Gitea server
     shellcompletion, autocomplete  Install shell completion for tea
     whoami                         Show current logged in user

   --help, -h     show help (default: false)
   --version, -v  print the version (default: false)

   tea login add                       # add a login once to get started

   tea pulls                           # list open pulls for the repo in $PWD
   tea pulls --repo $HOME/foo          # list open pulls for the repo in $HOME/foo
   tea pulls --remote upstream         # list open pulls for the repo pointed at by
                                       # your local "upstream" git remote
   # list open pulls for any gitea repo at the given login instance
   tea pulls --repo gitea/tea --login gitea.com

   tea milestone issues 0.7.0          # view open issues for milestone '0.7.0'
   tea issue 189                       # view contents of issue 189
   tea open 189                        # open web ui for issue 189
   tea open milestones                 # open web ui for milestones

   # send gitea desktop notifications every 5 minutes (bash + libnotify)
   while :; do tea notifications --mine -o simple | xargs -i notify-send {}; sleep 300; done

   Written & maintained by The Gitea Authors.
   If you find a bug or want to contribute, we'll welcome you at https://gitea.com/gitea/tea.
   More info about Gitea itself on https://about.gitea.com.


There are different ways to get tea:

  1. Install via your system package manager:

    • macOS via brew (official):
      brew install tea
    • arch linux (gitea-tea-git, thirdparty)
    • alpine linux (tea, thirdparty)
  2. Use the prebuilt binaries from dl.gitea.com

  3. Install from source: see Compilation

  4. Docker (thirdparty): tgerczei/tea

  5. asdf (thirdparty): mvaldes14/asdf-tea


Make sure you have a current go version installed (1.13 or newer).

  • To compile the source yourself with the recommended flags & tags:

    git clone https://gitea.com/gitea/tea.git # or: tea clone gitea.com/gitea/tea ;)
    cd tea

    Note that GNU Make (gmake on OpenBSD) is required. If you want to install the compiled program you have to execute the following command:

    make install

    This installs the binary into the "bin" folder inside of your GOPATH folder (go env GOPATH). It is possible that this folder isn't in your PATH Environment Variable.

  • For a quick installation without git & make, set $version and exec:

    go install code.gitea.io/tea@${version}


Fork -> Patch -> Push -> Pull Request

  • make test run testsuite
  • make vet run checks (check the order of imports; preventing failure on CI pipeline beforehand)
  • ... (for other development tasks, check the Makefile)

Please read the CONTRIBUTING documentation, it will tell you about internal structures and concepts.


This project is under the MIT License. See the LICENSE file for the full license text.