mirror of https://gitea.com/gitea/tea synced 2024-11-18 09:25:36 +00:00

Norwin 287df8a715 Add command to install shell completion (#309 )

add autocompletion files to contrib/

curl -o contrib/autocomplete.zsh https://raw.githubusercontent.com/urfave/cli/master/autocomplete/zsh_autocomplete
curl -o contrib/autocomplete.sh https://raw.githubusercontent.com/urfave/cli/master/autocomplete/bash_autocomplete
add powershell

add `tea meta autocomplete`

closes #86

update docs

Co-authored-by: Norwin Roosen <git@nroo.de>
Reviewed-on: https://gitea.com/gitea/tea/pulls/309
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-by: 6543 <6543@obermui.de>
Co-Authored-By: Norwin <noerw@noreply.gitea.io>
Co-Committed-By: Norwin <noerw@noreply.gitea.io>

2020-12-17 00:01:59 +08:00

3.7 KiB

Raw Blame History

T E A

The official CLI interface for gitea

Tea is a command line tool for interacting on one or more Gitea instances. It uses code.gitea.io/sdk and interacts with the Gitea API

For a feature comparison with other git forge CLIs see here.

Installation

You can use the prebuilt binaries from dl.gitea.io

To install from source, go 1.13 or newer is required:

go get code.gitea.io/tea
go install code.gitea.io/tea

If you have brew installed, you can install tea via:

brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
brew install tea

Distribution packages exist for: alpinelinux (tea) and archlinux (gitea-tea)

Shell completion can be added via tea autocomplete --install.

Usage

First of all, you have to create a token on your personal settings -> application page of your gitea instance. Use this token to login with tea:

tea login add --name=try --url=https://try.gitea.io --token=xxxxxx

Now you can use the following tea subcommands. Detailed usage information is available via tea <command> --help.

login            Log in to a Gitea server
logout           Log out from a Gitea server
issues           List, create and update issues
pulls            List, create, checkout and clean pull requests
releases         List, create, update and delete releases
repos            Operate with repositories
labels           Manage issue labels
times            Operate on tracked times of a repositorys issues and pulls
open             Open something of the repository on web browser
notifications    Show notifications
milestones       List and create milestones
organizations    List, create, delete organizations
help, h          Shows a list of commands or help for one command

To fetch issues from different repos, use the --remote flag (when inside a gitea repository directory) or --login & --repo flags.

Compilation

Make sure you have installed a current go version. To compile the sources yourself run the following:

git clone https://gitea.com/gitea/tea.git
cd tea
make

Contributing

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.

License

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

3.7 KiB Raw Blame History