Skip to content

tea

tea documentation

Tea

Bases: Tool[_R]

Classes:

Name Description
Branches
Comments
Issues
Labels
Logins
Milestones
Pulls
Releases
Repos
Api
Clone
Whoami

Methods:

Name Description
__call__

Run this verb.

flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
branches Branches[_R]
comments Comments[_R]
issues Issues[_R]
labels Labels[_R]
logins Logins[_R]
milestones Milestones[_R]
pulls Pulls[_R]
releases Releases[_R]
repos Repos[_R]
api Api[_R]
clone Clone[_R]
whoami Whoami[_R]
argv Tea[Argv]

branches instance-attribute

branches: Branches[_R]

comments instance-attribute

comments: Comments[_R]

issues instance-attribute

issues: Issues[_R]

labels instance-attribute

labels: Labels[_R]

logins instance-attribute

logins: Logins[_R]

milestones instance-attribute

milestones: Milestones[_R]

pulls instance-attribute

pulls: Pulls[_R]

releases instance-attribute

releases: Releases[_R]

repos instance-attribute

repos: Repos[_R]

api instance-attribute

api: Api[_R]

clone instance-attribute

clone: Clone[_R]

whoami instance-attribute

whoami: Whoami[_R]

argv property

argv: Tea[Argv]

Branches

Bases: Tool[_R2]

Classes:

Name Description
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
list List[_R2]
argv Branches[Argv]

list instance-attribute

list: List[_R2]

argv property

argv: Branches[Argv]

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., fields: Value = ..., limit: Value = ..., login: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
fields Value

Comma-separated list of fields to print. Defaults to name,protected,user-can-merge,user-can-push.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Comments

Bases: Tool[_R2]

Classes:

Name Description
Add
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
add Add[_R2]
list List[_R2]
argv Comments[Argv]

add instance-attribute

add: Add[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Comments[Argv]

Add

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Add[Argv]
argv property
argv: Add[Argv]
__call__
__call__(issue: str | PathLike[str], /, *args: str | PathLike[str], debug: Flag = ..., description: Value = ..., login: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
description Value

comment body (alternative to the positional argument).

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(issue: str | PathLike[str], /, *args: str | PathLike[str], debug: Flag = ..., limit: Value = ..., login: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Issues

Bases: Tool[_R2]

Classes:

Name Description
Close
Create
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
close Close[_R2]
create Create[_R2]
list List[_R2]
argv Issues[Argv]

close instance-attribute

close: Close[_R2]

create instance-attribute

create: Create[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Issues[Argv]

Close

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Close[Argv]
argv property
argv: Close[Argv]
__call__
__call__(issue: str | PathLike[str], /, *args: str | PathLike[str], debug: Flag = ..., login: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*, assignees: Value = ..., deadline: Value = ..., debug: Flag = ..., description: Value = ..., labels: Value = ..., login: Value = ..., milestone: Value = ..., referenced_version: Value = ..., remote: Value = ..., repo: Value = ..., title: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
assignees Value

Comma-separated list of usernames to assign.

...
deadline Value

Deadline timestamp to assign.

...
debug Flag

Enable debug mode.

...
labels Value

Comma-separated list of labels to assign.

...
login Value

Use a different Gitea Login.

...
milestone Value

Milestone to assign.

...
referenced_version Value

commit-hash or tag name to assign.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, assignee: Value = ..., author: Value = ..., debug: Flag = ..., fields: Value = ..., from_: Value = ..., keyword: Value = ..., kind: Value = ..., labels: Value = ..., limit: Value = ..., login: Value = ..., mentions: Value = ..., milestones: Value = ..., output: Value = ..., owner: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., state: Value = ..., until: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
fields Value

Comma-separated list of fields to print. Defaults to index,title,state,author,milestone,labels,owner,repo.

...
from_ Value

Filter by activity after this date.

...
keyword Value

Filter by search string.

...
kind Value

Whether to return issues, pulls, or all (you can use this to apply advanced search filters to PRs). Defaults to issues.

...
labels Value

Comma-separated list of labels to match issues against.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
milestones Value

Comma-separated list of milestones to match issues against.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
state Value

Filter by state (all|open|closed). Defaults to open.

...
until Value

Filter by activity before this date.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Labels

Bases: Tool[_R2]

Classes:

Name Description
Create
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
create Create[_R2]
list List[_R2]
argv Labels[Argv]

create instance-attribute

create: Create[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Labels[Argv]

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*, color: Value = ..., debug: Flag = ..., description: Value = ..., file: Value = ..., login: Value = ..., name: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
color Value

label color value.

...
debug Flag

Enable debug mode.

...
description Value

label description.

...
file Value

indicate a label file.

...
login Value

Use a different Gitea Login.

...
name Value

label name.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., exclude_org: Flag = ..., limit: Value = ..., login: Value = ..., org: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., save: Flag = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
exclude_org Flag

Exclude organization labels from the list.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
org Value

List organization labels.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
save Flag

Save all the labels as a file.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Logins

Bases: Tool[_R2]

Classes:

Name Description
Add
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
add Add[_R2]
list List[_R2]
argv Logins[Argv]

add instance-attribute

add: Add[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Logins[Argv]

Add

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Add[Argv]
argv property
argv: Add[Argv]
__call__
__call__(*, client_id: Value = ..., debug: Flag = ..., git_credentials: Flag = ..., insecure: Flag = ..., name: Value = ..., no_version_check: Flag = ..., oauth: Flag = ..., otp: Value = ..., password: Value = ..., redirect_url: Value = ..., scopes: Value = ..., ssh_agent_key: Value = ..., ssh_agent_principal: Value = ..., ssh_key: Value = ..., token: Value = ..., url: Value = ..., user: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
client_id Value

OAuth client ID (for use with --oauth).

...
debug Flag

Enable debug mode.

...
git_credentials Flag

Register tea as a git credential helper for this login's URL, so 'git push' and 'git clone' over HTTPS authenticate silently using the stored token.

...
insecure Flag

Disable TLS verification.

...
name Value

Login name.

...
no_version_check Flag

Do not check version of Gitea instance.

...
oauth Flag

Use interactive OAuth2 flow for authentication.

...
otp Value

OTP token for auth, if necessary [%GITEA_SERVER_OTP%].

...
password Value

Password for basic auth (will create token) [%GITEA_SERVER_PASSWORD%].

...
redirect_url Value

OAuth redirect URL (for use with --oauth).

...
scopes Value

Token scopes to add when creating a new token, separated by a comma [%GITEA_SCOPES%].

...
ssh_agent_key Value

Use SSH public key or SSH fingerprint to login (needs a running ssh-agent with ssh key loaded).

...
ssh_agent_principal Value

Use SSH certificate with specified principal to login (needs a running ssh-agent with certificate loaded).

...
ssh_key Value

Path to a SSH key/certificate to use, overrides auto-discovery.

...
token Value

Access token.

...
url Value

Server URL [%GITEA_SERVER_URL%]. Defaults to https://gitea.com.

...
user Value

User for basic auth (will create token) [%GITEA_SERVER_USER%].

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., output: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
output Value

Output format.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Milestones

Bases: Tool[_R2]

Classes:

Name Description
Create
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
create Create[_R2]
list List[_R2]
argv Milestones[Argv]

create instance-attribute

create: Create[_R2]

list instance-attribute

list: List[_R2]

argv property

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*, deadline: Value = ..., debug: Flag = ..., description: Value = ..., login: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., state: Value = ..., title: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
deadline Value

set milestone deadline. Defaults to is no due date.

...
debug Flag

Enable debug mode.

...
description Value

milestone description to create.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
state Value

set milestone state. Defaults to is open.

...
title Value

milestone title to create.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., fields: Value = ..., limit: Value = ..., login: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., state: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
fields Value

Comma-separated list of fields to print. Defaults to title,items,duedate.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
state Value

Filter by milestone state (all|open|closed). Defaults to open.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Pulls

Bases: Tool[_R2]

Classes:

Name Description
Checkout
Create
List
Merge

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
checkout Checkout[_R2]
create Create[_R2]
list List[_R2]
merge Merge[_R2]
argv Pulls[Argv]

checkout instance-attribute

checkout: Checkout[_R2]

create instance-attribute

create: Create[_R2]

list instance-attribute

list: List[_R2]

merge instance-attribute

merge: Merge[_R2]

argv property

argv: Pulls[Argv]

Checkout

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Checkout[Argv]
argv property
argv: Checkout[Argv]
__call__
__call__(pull: str | PathLike[str], /, *args: str | PathLike[str], branch: Flag = ..., debug: Flag = ..., login: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
branch Flag

Create a local branch if it doesn't exist yet.

...
debug Flag

Enable debug mode.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*, agit: Flag = ..., allow_maintainer_edits: Flag = ..., assignees: Value = ..., base: Value = ..., deadline: Value = ..., debug: Flag = ..., description: Value = ..., draft: Flag = ..., head: Value = ..., labels: Value = ..., login: Value = ..., milestone: Value = ..., referenced_version: Value = ..., remote: Value = ..., repo: Value = ..., title: Value = ..., topic: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
agit Flag

Create an agit flow pull request.

...
allow_maintainer_edits Flag

Enable maintainers to push to the base branch of created pull.

...
assignees Value

Comma-separated list of usernames to assign.

...
base Value

Branch name of the PR target. Defaults to is repos default branch.

...
deadline Value

Deadline timestamp to assign.

...
debug Flag

Enable debug mode.

...
draft Flag

Create as a draft (prepends "WIP: " to the title; Gitea treats WIP-prefixed PRs as drafts).

...
head Value

Branch name of the PR source . Defaults to is current one.

...
labels Value

Comma-separated list of labels to assign.

...
login Value

Use a different Gitea Login.

...
milestone Value

Milestone to assign.

...
referenced_version Value

commit-hash or tag name to assign.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
topic Value

Topic name for agit flow pull request.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., fields: Value = ..., limit: Value = ..., login: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., state: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
fields Value

Comma-separated list of fields to print. Defaults to index,title,state,author,milestone,updated,labels.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
state Value

Filter by state (all|open|closed). Defaults to open.

...

Merge

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Merge[Argv]
argv property
argv: Merge[Argv]
__call__
__call__(pull: str | PathLike[str], /, *args: str | PathLike[str], debug: Flag = ..., login: Value = ..., message: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., style: Value = ..., title: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
login Value

Use a different Gitea Login.

...
message Value

Merge commit message.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
style Value

Kind of merge to perform: merge, rebase, squash, rebase-merge. Defaults to merge.

...
title Value

Merge commit title.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Releases

Bases: Tool[_R2]

Classes:

Name Description
Assets
Create
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
assets Assets[_R2]
create Create[_R2]
list List[_R2]
argv Releases[Argv]

assets instance-attribute

assets: Assets[_R2]

create instance-attribute

create: Create[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Releases[Argv]

Assets

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Assets[Argv]
argv property
argv: Assets[Argv]
__call__
__call__(*args: str | PathLike[str], debug: Flag = ..., login: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*args: str | PathLike[str], asset: Value = ..., debug: Flag = ..., draft: Flag = ..., login: Value = ..., note: Value = ..., note_file: Value = ..., output: Value = ..., prerelease: Flag = ..., remote: Value = ..., repo: Value = ..., tag: Value = ..., target: Value = ..., title: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
asset Value

Path to file attachment. May be repeated: a list emits the flag once per item.

...
debug Flag

Enable debug mode.

...
draft Flag

Is a draft.

...
login Value

Use a different Gitea Login.

...
note Value

Release notes.

...
note_file Value

Release notes file name.

...
output Value

Output format.

...
prerelease Flag

Is a pre-release.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...
tag Value

Tag name.

...
target Value

Target branch name or commit hash.

...
title Value

Release title.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., limit: Value = ..., login: Value = ..., output: Value = ..., page: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
page Value

specify page. Defaults to 1.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Repos

Bases: Tool[_R2]

Classes:

Name Description
Create
Fork
List

Methods:

Name Description
__call__
flags

Bind tool-level global options before the subcommand.

Attributes:

Name Type Description
create Create[_R2]
fork Fork[_R2]
list List[_R2]
argv Repos[Argv]

create instance-attribute

create: Create[_R2]

fork instance-attribute

fork: Fork[_R2]

list instance-attribute

list: List[_R2]

argv property

argv: Repos[Argv]

Create

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Create[Argv]
argv property
argv: Create[Argv]
__call__
__call__(*, branch: Value = ..., debug: Flag = ..., description: Value = ..., gitignores: Value = ..., init: Flag = ..., labels: Value = ..., license: Value = ..., login: Value = ..., name: Value = ..., object_format: Value = ..., output: Value = ..., owner: Value = ..., private: Flag = ..., readme: Value = ..., template: Flag = ..., trustmodel: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
branch Value

use custom default branch (need --init).

...
debug Flag

Enable debug mode.

...
description Value

add description to repo.

...
gitignores Value

list of gitignore templates (need --init).

...
init Flag

initialize repo.

...
labels Value

name of label set to add.

...
license Value

add license (need --init).

...
login Value

Use a different Gitea Login.

...
name Value

name of new repo.

...
object_format Value

select git object format (sha1,sha256).

...
output Value

Output format.

...
owner Value

name of repo owner.

...
private Flag

make repo private.

...
readme Value

use readme template (need --init).

...
template Flag

make repo a template repo.

...
trustmodel Value

select trust model (committer,collaborator,collaborator+committer).

...

Fork

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Fork[Argv]
argv property
argv: Fork[Argv]
__call__
__call__(*, debug: Flag = ..., login: Value = ..., owner: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
login Value

Use a different Gitea Login.

...
owner Value

name of fork's owner, defaults to current user.

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

List

Bases: Tool[_R3]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv List[Argv]
argv property
argv: List[Argv]
__call__
__call__(*, debug: Flag = ..., fields: Value = ..., limit: Value = ..., login: Value = ..., output: Value = ..., owner: Value = ..., page: Value = ..., starred: Flag = ..., type: Value = ..., watched: Flag = ..., **flags: Any) -> _R3

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
fields Value

Comma-separated list of fields to print. Defaults to owner,name,type,ssh.

...
limit Value

specify limit of items per page. Defaults to 30.

...
login Value

Use a different Gitea Login.

...
output Value

Output format.

...
owner Value

List repos of a specific owner (org or user).

...
page Value

specify page. Defaults to 1.

...
starred Flag

List your starred repos instead.

...
type Value

Filter by type: fork, mirror, source.

...
watched Flag

List your watched repos instead.

...

__call__

__call__(*args: Any, **flags: Any) -> _R2

flags

flags(**flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.

Api

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Api[Argv]

argv property

argv: Api[Argv]

__call__

__call__(endpoint: str | PathLike[str], /, *args: str | PathLike[str], Field: Value = ..., data: Value = ..., debug: Flag = ..., field: Value = ..., header: Value = ..., include: Flag = ..., login: Value = ..., method: Value = ..., output: Value = ..., remote: Value = ..., repo: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
Field Value

Add a typed field to the request body (key=value, @file, or @- for stdin).

...
data Value

Raw JSON request body (use @file to read from file, @- for stdin).

...
debug Flag

Enable debug mode.

...
field Value

Add a string field to the request body (key=value).

...
header Value

Add a custom header (key:value).

...
include Flag

Include HTTP status and response headers in output (written to stderr).

...
login Value

Use a different Gitea Login.

...
method Value

HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET.

...
output Value

Write response body to file instead of stdout (use '-' for stdout).

...
remote Value

Discover Gitea login from remote.

...
repo Value

Override local repository path or gitea repository slug to interact with.

...

Clone

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Clone[Argv]

argv property

argv: Clone[Argv]

__call__

__call__(repo_slug: str | PathLike[str], /, *args: str | PathLike[str], debug: Flag = ..., depth: Value = ..., login: Value = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...
depth Value

num commits to fetch, defaults to all. Defaults to 0.

...
login Value

Use a different Gitea Login.

...

Whoami

Bases: Tool[_R2]

Methods:

Name Description
__call__

Run this verb.

Attributes:

Name Type Description
argv Whoami[Argv]

argv property

argv: Whoami[Argv]

__call__

__call__(*, debug: Flag = ..., **flags: Any) -> _R2

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...

__call__

__call__(*args: str | PathLike[str], debug: Flag = ..., **flags: Any) -> _R

Run this verb.

Parameters:

Name Type Description Default
debug Flag

Enable debug mode.

...

flags

flags(*, debug: Flag = ..., **flags: Any) -> Self

Bind tool-level global options before the subcommand.

tools.docker.flags(host=...) puts a tool's own options ahead of the verb, where they belong.