bircni
a2bea8da23
tea auth login without a method flag asks on a terminal for the instance (prefilled from the repository, default_host or the only instance), how to log in (token, browser, SSH key), the pasted token without echo with a link to the applications page, where to keep it and whether git should use tea for the instance. Bare hosts are accepted. Logging in to an account tea already has replaces its credential after a confirmation, or with --yes; a named account is confirmed before the token is asked for. Every login ends with "Logged in to HOST as USER (token, keyring)". OAuth requests write scopes for everything but administration by default, and --scopes chooses others; --web is an alias of --oauth. auth status prints a block per instance with the active account, how each account authenticates, its expiry, verification and token scopes, whether git uses tea, and the GITEA_TOKEN of the environment. Piped it prints tab-separated fields. It fails with exit code 4 when no account or no usable credential exists instead of printing nothing. auth switch takes the instance of the repository, --host, default_host or the sole instance instead of requiring --host, toggles between two accounts, asks on a terminal with more, and accepts --user. auth logout takes the account as an argument, names it in its errors, and asks git's other credential helpers to forget what they stored for the account. auth refresh points token accounts to tea auth login --with-token, and the new auth token prints the token of an account for scripts. Every auth command reports what it did on a terminal and has a long help text and examples. Signed-off-by: bircni <bircni@icloud.com>
T E A
The official CLI for Gitea
Tea manages repositories, issues, pull requests, releases, and other Gitea resources with explicit commands suitable for local development and CI.
tea auth login --host https://gitea.example.org --with-token < token-file
tea issue list --repo owner/repository
tea pr view 123 --repo owner/repository --json
tea alias set bugs 'issue list --label bug'
tea help
tea 1.0 is a breaking release: it requires Gitea 28 or newer, commands, flags and
output formats changed, it uses separate config.yml and hosts.yml files, and it
requires fresh authentication.
Existing combined configuration files are left untouched; archive the old file or
choose an isolated TEA_CONFIG_DIR before setup. See
Migrating to tea 1.0 for the old-to-new mapping.
Run tea --help or tea <command> --help for supported commands and flags; the
full reference, man pages, and shell completions ship in each release's docs archive.
Credentials use the operating-system keyring by default; explicitly
select --credential-store file when private file storage is needed. For CI,
supply GITEA_TOKEN and its instance through TEA_HOST or GITEA_INSTANCE_URL;
environment credentials are never persisted.
Installation
There are different ways to get tea:
-
Install via your system package manager:
-
Use the prebuilt binaries from dl.gitea.com
-
Install from source: see Compilation
-
Docker: Tea at docker hub
Log in to Gitea from tea
Gitea can use many different authentication schemes, and not every authentication method will work with every Gitea deployment. When you are a Gitea instance administrator you can tweak your settings to fit your use case. For the method that is most likely to work with any Gitea deployment use the following steps:
-
Open your Gitea instance in a web browser
-
Log in to Gitea in your web browser. Any MFA, IDP, or whatever else should be available this way.
-
In your "user settings", generate an application token with at least user read permissions. If you want to do anything useful with the token add additional permissions/scopes.
-
Save the token in a private file and run
tea auth login --host https://your-instance --with-token < token-file. Credentials use the operating-system keyring by default.
You should now be logged in to your gitea instance from tea.
Alternatively, tea auth login --host https://your-instance --oauth authorizes tea in your browser. OAuth may not be available on all Gitea deployments, and needs a browser on the machine running tea.
Shell completion
If you installed from source or the package does not provide the completions with it you can add them yourself with tea completion <shell> command. Completion offers commands, flags, flag values such as --state and --json fields, and values from your instance such as repositories. Add the line for your shell to its startup file:
# ~/.bashrc (on macOS, ~/.bash_profile)
eval "$(tea completion bash)"
# ~/.zshrc, after compinit
autoload -U compinit && compinit
source <(tea completion zsh)
# fish
tea completion fish > ~/.config/fish/completions/tea.fish
# PowerShell profile
tea completion powershell | Out-String | Invoke-Expression
The bash script needs the bash-completion package. On macOS, install bash-completion with Homebrew for the system bash 3.2 (or bash-completion@2 for a Homebrew bash 4.2+), and use eval as above: bash 3.2 cannot source <(...). Without compinit, zsh reports command not found: compdef. tea completion <shell> --help shows these steps and how to install the script system-wide.
Man Page
The hidden command tea man can be used to generate the tea man page.
# for bash or zsh
man <(tea man)
# for fish
man (tea man | psub)
# write man page to a file
tea man --output-file ./tea.man
Compilation
Make sure you have a current Go version installed (1.27 or newer).
-
To compile the source yourself with the recommended flags & tags:
git clone https://gitea.com/gitea/tea.git # or: tea repo clone https://gitea.com/gitea/tea ;) cd tea makeNote that GNU Make (gmake on OpenBSD) is required. If you want to install the compiled program you have to execute the following command:
make installThis installs the binary into the "bin" folder inside of your GOPATH folder (
go env GOPATH). It is possible that this folder isn't in your PATH Environment Variable. -
For a quick installation without
git&make, set $version and exec:go install gitea.dev/tea@${version}
Contributing
Fork -> Patch -> Push -> Pull Request
make testrun unit testsmake vetrun checks (check the order of imports; preventing failure on CI pipeline beforehand)make buildbuilds the production CLImake docsregenerates references, man pages, and shell completions indocs/generated(not committed; built on release)- ... (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.