aniani/tea

mirror of https://gitea.com/gitea/tea.git synced 2024-12-04 14:46:40 -05:00

Go to file

6543 48c1c50796 Update Docu to new Structure (#247 ) reword styleguide adapt contributing to tea add info from #184 new structure Update CONTRIBUTING mention CONTRIBUTING.md in README Remove Authors form README (close #225) Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Norwin Roosen <git@nroo.de> Reviewed-on: https://gitea.com/gitea/tea/pulls/247 Reviewed-by: Norwin <noerw@noreply.gitea.io> Reviewed-by: techknowlogick <techknowlogick@gitea.io> Co-Authored-By: 6543 <6543@noreply.gitea.io> Co-Committed-By: 6543 <6543@noreply.gitea.io>		2020-10-25 07:48:20 +08:00
cmd	improve formatting of `tea repos` (#223 )	2020-10-10 01:17:31 +00:00
modules	improve formatting of `tea repos` (#223 )	2020-10-10 01:17:31 +00:00
vendor	rewrote config file path search (#219 )	2020-10-06 13:06:47 +00:00
.changelog.yml	Add missing Changelog for 0.1.x releases (#91 )	2020-01-31 02:24:57 +00:00
.drone.yml	Update Golang (#185 )	2020-09-19 15:29:15 +00:00
.gitignore	Add gitea-vet (#121 )	2020-04-28 13:02:21 +00:00
.revive.toml	Add Makefile / .drone.yml, use go module with vendor (#20 )	2019-04-25 20:06:53 +03:00
build.go	Update gitea-vet v0.2.0 (#164 )	2020-07-21 16:17:52 +00:00
CHANGELOG.md	Changelog v0.5.0 (#205 )	2020-09-27 14:35:53 +00:00
CONTRIBUTING.md	Update Docu to new Structure (#247 )	2020-10-25 07:48:20 +08:00
DCO	init project	2018-09-03 14:43:00 +08:00
go.mod	rewrote config file path search (#219 )	2020-10-06 13:06:47 +00:00
go.sum	rewrote config file path search (#219 )	2020-10-06 13:06:47 +00:00
LICENSE	init project	2018-09-03 14:43:00 +08:00
main.go	Add Detail View for Login (#212 )	2020-10-02 15:57:48 +00:00
Makefile	Update gitea-vet v0.2.0 (#164 )	2020-07-21 16:17:52 +00:00
README.md	Update Docu to new Structure (#247 )	2020-10-25 07:48:20 +08:00

README.md

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

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)

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

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 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.