gitea/tea
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 16 Wiki Activity

fix: correct CLI.md with output of "make docs"

Browse Source 
Signed-off-by: Leonard Vimond <leonard.vimond.e@thalesdigital.io>
This commit is contained in:
Leonard Vimond 2024-04-17 09:45:43 +02:00
parent 5f626ecd1d
commit 4550ef60df
1 changed files with 82 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
docs/CLI.md
View File

@ -273,66 +273,6 @@ Change state of one ore more issues to 'closed'
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional **--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
## branches, branch, b
List, protect or unprotect branches
**--comments**: Whether to display comments (will prompt if not provided & run interactively)
**--fields value, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: "name,protected,user-can-merge,user-can-push")
**--page, -p**="": specify page, default is 1
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
### list, ls
**--fields value, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: "name,protected,user-can-merge,user-can-push")
**--page, -p**="": specify page, default is 1
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
### protect, P
Protect one or more branches against push/pull
**--login, -l**="": Use a different Gitea Login. Optional
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
### unprotect, U
Unprotect one or more branches against push/pull
**--login, -l**="": Use a different Gitea Login. Optional
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
## pulls, pull, pr ## pulls, pull, pr
Manage and checkout pull requests Manage and checkout pull requests
@ -1179,6 +1119,88 @@ Migrate a repository
**--wiki**: Copy the wiki **--wiki**: Copy the wiki
## branches, branch, b
Consult branches
**--comments**: Whether to display comments (will prompt if not provided & run interactively)
**--fields, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: name,protected,user-can-merge,user-can-push)
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
**--page, -p**="": specify page, default is 1
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
### list, ls
List branches of the repository
**--fields, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: name,protected,user-can-merge,user-can-push)
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
**--page, -p**="": specify page, default is 1
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
### protect, P
Protect branches
**--fields, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: name,protected,user-can-merge,user-can-push)
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
**--page, -p**="": specify page, default is 1
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
### unprotect, U
Unprotect branches
**--fields, -f**="": Comma-separated list of fields to print. Available values:
name,protected,user-can-merge,user-can-push,protection
(default: name,protected,user-can-merge,user-can-push)
**--limit, --lm**="": specify limit of items per page
**--login, -l**="": Use a different Gitea Login. Optional
**--output, -o**="": Output format. (simple, table, csv, tsv, yaml, json)
**--page, -p**="": specify page, default is 1
**--remote, -R**="": Discover Gitea login from remote. Optional
**--repo, -r**="": Override local repository path or gitea repository slug to interact with. Optional
## comment, c ## comment, c
Add a comment to an issue / pr Add a comment to an issue / pr