mirror of
https://gitea.com/gitea/tea
synced 2024-11-26 06:07:38 +01:00
287df8a715
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>
93 lines
3.7 KiB
Markdown
93 lines
3.7 KiB
Markdown
# <img alt='' src='https://gitea.com/repo-avatars/550-80a3a8c2ab0e2c2d69f296b7f8582485' height="40"/> *T E A*
|
|
|
|
[](https://opensource.org/licenses/MIT) [](https://gitea.com/gitea/tea/releases) [](https://drone.gitea.com/gitea/tea) [](https://discord.gg/Gitea) [](https://goreportcard.com/report/code.gitea.io/tea) [](https://godoc.org/code.gitea.io/tea)
|
|
|
|
## 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](https://code.gitea.io/sdk) and interacts with the Gitea API
|
|
|
|
|
|
|
|
For a feature comparison with other git forge CLIs see [here](./FEATURE-COMPARISON.md).
|
|
|
|
## Installation
|
|
|
|
You can use the prebuilt binaries from [dl.gitea.io](https://dl.gitea.io/tea/)
|
|
|
|
To install from source, go 1.13 or newer is required:
|
|
|
|
```sh
|
|
go get code.gitea.io/tea
|
|
go install code.gitea.io/tea
|
|
```
|
|
|
|
If you have `brew` installed, you can install `tea` via:
|
|
|
|
```sh
|
|
brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
|
|
brew install tea
|
|
```
|
|
|
|
Distribution packages exist for: **alpinelinux ([tea](https://pkgs.alpinelinux.org/packages?name=tea&branch=edge))** and **archlinux ([gitea-tea](https://aur.archlinux.org/packages/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`:
|
|
|
|
```sh
|
|
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`.
|
|
|
|
```none
|
|
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:
|
|
|
|
```sh
|
|
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](CONTRIBUTING.md) documentation, it will tell you about internal structures and concepts.
|
|
|
|
## License
|
|
|
|
This project is under the MIT License. See the [LICENSE](LICENSE) file for the
|
|
full license text.
|