github¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github [OPTIONS] COMMAND [ARGS]...[0m[1m [0m[1m [0m
[1m [0m
GitHub tools.
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Commands [0m[2m──────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36msubmit-pr [0m[1;36m [0m Submit a pr if mergeable. [2m│[0m
[2m│[0m [1;36mvotes [0m[1;36m [0m Helper for votes. [2m│[0m
[2m│[0m [1;36mlist [0m[1;36m [0m List options for github org repos. [2m│[0m
[2m│[0m [1;36mcreate-repo [0m[1;36m [0m Create a Github repo within an Organization. [2m│[0m
[2m│[0m [1;36mupdate-repo [0m[1;36m [0m Update a Github repo within an Organization. [2m│[0m
[2m│[0m [1;36mcreate-team [0m[1;36m [0m Create a Github team within an Organization. [2m│[0m
[2m│[0m [1;36muser [0m[1;36m [0m Add and Remove users from an org team. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
Commands¶
create-repo¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github create-repo [OPTIONS] {organization} {repository}[0m[1m [0m[1m [0m
[1m [0m[1m {description}[0m[1m [0m[1m [0m
[1m [0m
Create a Github repo within an Organization.
[2mRequires an admin token.[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repository [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Repository name to create [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m description [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Repository description [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-issues[0m Repo should have issues [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-projects[0m Repo should have projects [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-wiki[0m Repo should have wiki [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
create-team¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github create-team [OPTIONS] {organization} {name} {privacy}[0m[1m [0m
[1m [0m
Create a Github team within an Organization.
[2mPrivacy should be set to closed[0m[2m [0m[2mThis allows us to control group membership.[0m
[2mIf you have two factor auth enabled and you get a 401[0m[2m [0m[2merror, then you need to [0m
[2mcreate a personal access token[0m[2m [0m[2mand add it to your ~/.netrc file.[0m
[2mRequires an admin token.[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m name [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Team name to create [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m privacy [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Team privacy setting (closed/secret) [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-repo[0m [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Assign team to repo [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
list¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github list [OPTIONS] {organization}[0m[1m [0m[1m [0m
[1m [0m
List options for github org repos.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-audit[0m [1;33m [0m List members without 2fa [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-repos[0m [1;33m [0m List all repos [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-full[0m [1;33m [0m All members and their respective teams [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-teams[0m [1;33m [0m List available teams [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-team[0m [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m List members of a team [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-repofeatures[0m [1;33m [0m List enabled features for repos in an org [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
update-repo¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github update-repo [OPTIONS] {organization} {repository}[0m[1m [0m[1m [0m
[1m [0m
Update a Github repo within an Organization.
[2mRequires an admin token.[0m
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repository [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Repository name to update [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-issues[0m [1;33m [0m Repo should have issues [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-projects[0m [1;33m [0m Repo should have projects [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-has[0m[1;36m-wiki[0m [1;33m [0m Repo should have wiki [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-add[0m[1;36m-team[0m [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Add team to repo [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-remove[0m[1;36m-team[0m [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Remove team from repo [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m [1;33m [0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
submit-pr¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github submit-pr [OPTIONS] {organization} {repo} {pr}[0m[1m [0m[1m [0m
[1m [0m
Submit a pr if mergeable.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repo [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub repository name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m pr [1;2;33m<[0m[1;33mint[0m[1;2;33m>[0m Pull request number [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
user¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github user [OPTIONS] {organization} {user} {team}[0m[1m [0m[1m [0m
[1m [0m
Add and Remove users from an org team.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m user [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub username [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m team [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m Team name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-delete[0m Remove user from org [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-admin[0m User is admin for org, or a maintainer of a team [2m│[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
votes¶
[1m [0m
[1m [0m[1;33mUsage: [0m[1mlftools-uv github votes [OPTIONS] {organization} {repo} {pr}[0m[1m [0m[1m [0m
[1m [0m
Helper for votes.
[2mâ•â”€[0m[2m Arguments [0m[2m─────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [31m*[0m organization [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub organization name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m repo [1;2;33m<[0m[1;33mstr[0m[1;2;33m>[0m GitHub repository name [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m│[0m [31m*[0m pr [1;2;33m<[0m[1;33mint[0m[1;2;33m>[0m Pull request number [2m│[0m
[2m│[0m [2;31m[required] [0m [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
[2mâ•â”€[0m[2m Options [0m[2m───────────────────────────────────────────────────────────────────[0m[2m─╮[0m
[2m│[0m [1;36m-[0m[1;36m-help[0m Show this message and exit. [2m│[0m
[2m╰──────────────────────────────────────────────────────────────────────────────╯[0m
API requires a [github] or [github.OrgName] section in ~/.config/lftools-uv/lftools-uv.ini:
[github] or [github.orgName]
token = REDACTED