tea/README.md

1.8 KiB

Gitea Command Line Tool for Go

This project acts as a command line tool for operating one or multiple Gitea instances. It depends on code.gitea.io/sdk client SDK implementation written in Go to interact with the Gitea API implementation.

Installation

Currently no prebuilt binaries are provided. To install, a Go installation is needed.

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

If the tea executable is not found, you might need to set up your $GOPATH and $PATH variables first:

export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

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

brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea
brew install --devel 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 tea commands:

tea issues
tea releases

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

Compilation

To compile the sources yourself run the following:

go get code.gitea.io/tea
cd "${GOPATH}/src/code.gitea.io/tea"
go build

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.