tea/README.md
Norwin fb52920af9 Fix installation instructions (#11)
* improve README (#10)

fix installation instructions, improve usage guide

* Update README.md
2019-04-12 20:44:53 +03:00

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

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

If you are inside a git repository hosted on a gitea instance, you don't need to specify the --login and --repo flags!

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

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