mirror of https://gitea.com/gitea/tea.git synced 2024-06-16 06:25:25 +00:00
Go to file
Norwin 5e7c702e07 Clarify command descriptions when no arguments are taken (#496)
This changes the command help string from eg
   tea label create - Create a label

   tea label [command options] [arguments...]
   tea label create - Create a label

   tea label [command options]

Hopefully improving usability.


edit: this also changes `tea release create` to take the `--tag` flag value optionally via the first argument, as this seems to be a clear UX improvement.

fixes #483

Co-authored-by: Norwin <git@nroo.de>
Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: https://gitea.com/gitea/tea/pulls/496
Reviewed-by: techknowlogick <techknowlogick@gitea.io>
Reviewed-by: 6543 <6543@obermui.de>
Reviewed-by: delvh <delvh@noreply.gitea.io>
Co-authored-by: Norwin <noerw@noreply.gitea.io>
Co-committed-by: Norwin <noerw@noreply.gitea.io>
2022-09-14 02:14:02 +08:00
.gitea/issue_template Fix typo in bug.md (#460) 2022-02-20 00:30:58 +08:00
cmd Clarify command descriptions when no arguments are taken (#496) 2022-09-14 02:14:02 +08:00
contrib Add command to install shell completion (#309) 2020-12-17 00:01:59 +08:00
modules Update dependencies (#501) 2022-09-14 01:52:44 +08: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
.drone.yml Rename master branch to main (#495) 2022-08-26 23:34:40 +08:00
.gitignore Use golang v1.18 and drop vendor folder (#478) 2022-03-29 07:11:11 +08:00
.revive.toml Fix CI: disable package-comments lint rule (#494) 2022-08-22 20:53:19 +08:00
build.go Fix CI: run make fmt (#469) 2022-03-13 08:53:18 +08:00
CHANGELOG.md Changelog v0.8.0 (#404) 2021-09-23 03:53:33 +08:00
CONTRIBUTING.md Fix few typos in contribution guidelines (#459) 2022-02-22 22:34:58 +08:00
DCO init project 2018-09-03 14:43:00 +08:00
demo.gif Proper help text & new README structure (#311) 2020-12-21 21:37:20 +08:00
Dockerfile Makefile: add STATIC=true for static PIE builds (#349) 2021-09-24 00:01:07 +08:00
FEATURE-COMPARISON.md Add feature comparison chart between forge CLIs (#294) 2020-12-15 12:59:49 +08:00
go.mod Update dependencies (#501) 2022-09-14 01:52:44 +08:00
go.sum Update dependencies (#501) 2022-09-14 01:52:44 +08:00
LICENSE init project 2018-09-03 14:43:00 +08:00
main.go Show more version info (#486) 2022-06-18 22:34:18 +08:00
Makefile Show more version info (#486) 2022-06-18 22:34:18 +08:00
README.md Fix go install for go 1.17 (#481) 2022-04-26 14:07:15 +08:00


License: MIT Release Build Status 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://gitea.io.


There are different ways to get tea:

  1. Install via your system package manager:

    • macOS via brew (gitea-maintained):
      brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
      brew install tea
    • arch linux (gitea-tea-git, thirdparty)
    • alpine linux (tea, thirdparty)
  2. Use the prebuilt binaries from dl.gitea.io

  3. Install from source: see Compilation

  4. Docker (thirdparty): tgerczei/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.

  • For a quick installation without git & make:

    go install code.gitea.io/tea@latest


Fork -> Patch -> Push -> Pull Request

  • make test run testsuite
  • make vet run checks (check the order of imports; preventing failure on CI pipeline beforehand)
  • make vendor when adding new dependencies
  • ... (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.