gitea-tea/README.md
6543 8bbeeae327 Update Readme & add demo GIF (#125)
add suggestions from reviews & remove alias from subcomand list

gif is now on cdn & add review suggestion

Add ICON & Name

update description & co

add demo gif

fix newline becaues of new markdown roule

Co-authored-by: 6543 <6543@obermui.de>
Reviewed-on: https://gitea.com/gitea/tea/pulls/125
Reviewed-by: lafriks <lafriks@noreply.gitea.io>
Reviewed-by: Gary Kim <gary@garykim.dev>
2020-04-25 12:04:05 +00:00

3.0 KiB

T E A

License: MIT Release Build Status Join the chat at https://img.shields.io/discord/322538954119184384.svg Go Report Card GoDoc

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

demo gif

Installation

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

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

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

Or if you have brew installed, you can install tea via:

brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
brew install 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, checkout and clean pull requests
releases         Create 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

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)

Authors

License

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