naudachu
62027db76c
Two flags in the reference said one thing and did another. `-o` was listed as a global output-format flag and the Tips section recommended `-o json` without qualification. On `tea api` it is a file name: `-o json` writes the body to a file called json and leaves stdout empty, so the next parse fails with a JSONDecodeError that looks like a server refusal. Scoped to entity commands, and api's meaning named in all three places that mention it. `--repo owner/repo` was documented as a general substitute for standing in a checkout. For `pulls create`, `pulls checkout` and `pulls clean` it is not: the slug is rejected with 'local repository required', advice that reads like the flag was missing. Verified from outside any repo — those three refuse a slug and accept a path, while pulls list, milestones, releases and times take the slug from anywhere. All three working forms are written down, including the git-worktree one (point --repo at the main checkout) and the api fallback. Closes #35 Closes #28 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
37 lines
1.6 KiB
Markdown
37 lines
1.6 KiB
Markdown
# tea CLI — Index
|
|
|
|
Version: `tea 0.14.1` (go-sdk v0.25.1). Source: recursive `--help` traversal. Upstream: https://gitea.com/gitea/tea
|
|
|
|
`tea` is a productivity helper for Gitea. It uses the current git repository context (`$PWD`) — owner/repo/login are auto-detected when inside a repo. Config is persisted in `$XDG_CONFIG_HOME/tea`.
|
|
|
|
## Global options
|
|
|
|
- `--debug, --vvv` — enable debug mode
|
|
- `--help, -h`, `--version, -v`
|
|
|
|
## Common flags (present on nearly every command)
|
|
|
|
| Flag | Purpose |
|
|
|---|---|
|
|
| `--login, -l <name>` | use a specific login from the config |
|
|
| `--repo, -r <owner/repo>` | override repository context (local path or slug). **A slug only works where the command is pure API.** `pulls create`, `pulls checkout` and `pulls clean` need a real checkout and read this flag as a path — see [SKILL.md](../../SKILL.md) |
|
|
| `--remote, -R <name>` | discover login from this git remote |
|
|
| `--output, -o <fmt>` | output format: `simple, table, csv, tsv, yaml, json`. **Entity commands only** — on `tea api` the same flag is a FILE NAME, see [HELPERS](./helpers.md) |
|
|
| `--page, -p <n>` / `--limit, --lm <n>` | pagination (defaults 1 / 30) |
|
|
| `--fields, -f <list>` | which columns to print |
|
|
|
|
## Command categories
|
|
|
|
```
|
|
ENTITIES: issues, pulls, labels, milestones, releases, times,
|
|
organizations, repos, branches, actions, webhooks, comment
|
|
HELPERS: open, notifications, clone, api
|
|
MISC: whoami, admin
|
|
SETUP: logins, logout, ssh-keys
|
|
```
|
|
|
|
- [ENTITIES](./entities.md)
|
|
- [HELPERS](./helpers.md)
|
|
- [MISC](./misc.md)
|
|
- [SETUP](./setup.md)
|