2020-04-25 17:34:05 +05:30
# <img alt='' src='https://gitea.com/repo-avatars/550-80a3a8c2ab0e2c2d69f296b7f8582485' height="40"/> *T E A*
2018-09-03 12:13:00 +05:30
2020-04-25 17:34:05 +05:30
[![License: MIT ](https://img.shields.io/badge/License-MIT-blue.svg )](https://opensource.org/licenses/MIT) [![Release ](https://raster.shields.io/badge/dynamic/json.svg?label=release&url=https://gitea.com/api/v1/repos/gitea/tea/releases&query=$[0].tag_name )](https://gitea.com/gitea/tea/releases) [![Build Status ](https://drone.gitea.com/api/badges/gitea/tea/status.svg )](https://drone.gitea.com/gitea/tea) [![Join the chat at https://img.shields.io/discord/322538954119184384.svg ](https://img.shields.io/discord/322538954119184384.svg )](https://discord.gg/Gitea) [![Go Report Card ](https://goreportcard.com/badge/code.gitea.io/tea )](https://goreportcard.com/report/code.gitea.io/tea) [![GoDoc ](https://godoc.org/code.gitea.io/tea?status.svg )](https://godoc.org/code.gitea.io/tea)
2020-01-03 06:28:45 +05:30
2020-04-25 17:34:05 +05:30
## 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
![demo gif ](https://dl.gitea.io/screenshots/tea_demo.gif )
2018-09-03 12:13:00 +05:30
2020-12-15 10:29:49 +05:30
For a feature comparison with other git forge CLIs see [here ](./FEATURE-COMPARISON.md ).
2018-09-03 12:13:00 +05:30
## Installation
2019-04-26 17:21:03 +05:30
2020-04-25 17:34:05 +05:30
You can use the prebuilt binaries from [dl.gitea.io ](https://dl.gitea.io/tea/ )
2019-04-26 17:21:03 +05:30
2020-09-19 20:59:15 +05:30
To install from source, go 1.13 or newer is required:
2020-10-20 08:17:31 +05:30
2019-04-12 23:14:53 +05:30
```sh
2019-04-25 19:46:57 +05:30
go get code.gitea.io/tea
2019-04-12 23:14:53 +05:30
go install code.gitea.io/tea
2018-09-03 12:13:00 +05:30
```
2019-04-12 23:14:53 +05:30
2020-07-06 00:06:21 +05:30
If you have `brew` installed, you can install `tea` via:
2019-10-29 01:10:09 +05:30
```sh
brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
2020-04-25 17:34:05 +05:30
brew install tea
2019-10-29 01:10:09 +05:30
```
2020-07-06 00:06:21 +05:30
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))**
2018-09-03 12:13:00 +05:30
## Usage
2019-04-26 17:21:03 +05:30
2019-04-12 23:14:53 +05:30
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` :
2019-04-26 17:21:03 +05:30
2019-04-12 23:14:53 +05:30
```sh
2018-09-03 12:13:00 +05:30
tea login add --name=try --url=https://try.gitea.io --token=xxxxxx
2019-04-12 23:14:53 +05:30
```
2020-04-25 17:34:05 +05:30
Now you can use the following `tea` subcommands.
Detailed usage information is available via `tea <command> --help` .
2019-04-26 17:21:03 +05:30
2020-10-20 08:17:31 +05:30
```none
2020-04-25 17:34:05 +05:30
login Log in to a Gitea server
logout Log out from a Gitea server
issues List, create and update issues
2020-09-27 20:05:53 +05:30
pulls List, create, checkout and clean pull requests
releases List, create, update and delete releases
2020-04-25 17:34:05 +05:30
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
2020-09-27 20:05:53 +05:30
notifications Show notifications
milestones List and create milestones
2020-12-07 03:32:50 +05:30
organizations List, create, delete organizations
help, h Shows a list of commands or help for one command
2018-09-03 12:13:00 +05:30
```
2019-12-26 08:56:48 +05:30
To fetch issues from different repos, use the `--remote` flag (when inside a gitea repository directory) or `--login` & `--repo` flags.
2019-04-12 23:14:53 +05:30
2019-04-25 19:46:57 +05:30
## Compilation
2020-04-25 17:34:05 +05:30
Make sure you have installed a current go version.
2019-04-25 19:46:57 +05:30
To compile the sources yourself run the following:
2019-04-26 17:21:03 +05:30
2019-04-25 19:46:57 +05:30
```sh
2020-04-25 17:34:05 +05:30
git clone https://gitea.com/gitea/tea.git
cd tea
make
2019-04-25 19:46:57 +05:30
```
2018-09-03 12:13:00 +05:30
## Contributing
Fork -> Patch -> Push -> Pull Request
2019-12-26 08:56:48 +05:30
- `make test` run testsuite
2020-12-06 06:54:06 +05:30
- `make vet` run checks (check the order of imports; preventing failure on CI pipeline beforehand)
2019-12-26 08:56:48 +05:30
- `make vendor` when adding new dependencies
- ... (for other development tasks, check the `Makefile` )
2020-10-25 05:18:20 +05:30
**Please** read the [CONTRIBUTING ](CONTRIBUTING.md ) documentation, it will tell you about internal structures and concepts.
2018-09-03 12:13:00 +05:30
## License
This project is under the MIT License. See the [LICENSE ](LICENSE ) file for the
full license text.