From 4550ef60dfa8e89c2eac8388774a005f548c1078 Mon Sep 17 00:00:00 2001 From: Leonard Vimond Date: Wed, 17 Apr 2024 09:45:43 +0200 Subject: [PATCH] fix: correct CLI.md with output of "make docs" Signed-off-by: Leonard Vimond --- docs/CLI.md | 142 ++++++++++++++++++++++++++++++---------------------- 1 file changed, 82 insertions(+), 60 deletions(-) diff --git a/docs/CLI.md b/docs/CLI.md index b28919e..81680c5 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -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 -## 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 Manage and checkout pull requests @@ -1179,6 +1119,88 @@ Migrate a repository **--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 Add a comment to an issue / pr