From 6fde0c0016c3cffb8cfaa4099a0fa8b54ec05c93 Mon Sep 17 00:00:00 2001 From: bupd Date: Sat, 28 Dec 2024 09:11:26 +0530 Subject: [PATCH] add cli and man docs Signed-off-by: bupd --- doc/cli-docs/_index.md | 13 ---- doc/cli-docs/harbor-artifact-delete.md | 4 +- doc/cli-docs/harbor-artifact-info.md | 42 ------------- doc/cli-docs/harbor-artifact-list.md | 10 ++- doc/cli-docs/harbor-artifact-scan-start.md | 4 +- doc/cli-docs/harbor-artifact-scan-stop.md | 4 +- doc/cli-docs/harbor-artifact-scan.md | 4 +- doc/cli-docs/harbor-artifact-tags-create.md | 4 +- doc/cli-docs/harbor-artifact-tags-delete.md | 2 +- doc/cli-docs/harbor-artifact-tags-list.md | 4 +- doc/cli-docs/harbor-artifact-tags.md | 2 +- doc/cli-docs/harbor-artifact-view.md | 42 +++++++++++++ doc/cli-docs/harbor-artifact.md | 6 +- doc/cli-docs/harbor-health.md | 4 +- doc/cli-docs/harbor-label-create.md | 46 ++++++++++++++ doc/cli-docs/harbor-label-delete.md | 39 ++++++++++++ doc/cli-docs/harbor-label-list.md | 38 +++++++++++ doc/cli-docs/harbor-label-update.md | 42 +++++++++++++ doc/cli-docs/harbor-label.md | 32 ++++++++++ doc/cli-docs/harbor-login.md | 5 +- doc/cli-docs/harbor-project-create.md | 9 ++- doc/cli-docs/harbor-project-delete.md | 7 ++- doc/cli-docs/harbor-project-list.md | 7 ++- doc/cli-docs/harbor-project-logs.md | 4 +- doc/cli-docs/harbor-project-search.md | 32 ++++++++++ doc/cli-docs/harbor-project-view.md | 4 +- doc/cli-docs/harbor-project.md | 5 +- doc/cli-docs/harbor-registry-create.md | 14 +++-- doc/cli-docs/harbor-registry-delete.md | 12 +++- doc/cli-docs/harbor-registry-info.md | 32 ---------- doc/cli-docs/harbor-registry-list.md | 4 +- doc/cli-docs/harbor-registry-update.md | 20 +++--- doc/cli-docs/harbor-registry-view.md | 12 +++- doc/cli-docs/harbor-registry.md | 9 ++- doc/cli-docs/harbor-repo-delete.md | 4 +- doc/cli-docs/harbor-repo-list.md | 14 ++++- doc/cli-docs/harbor-repo-search.md | 32 ++++++++++ ...arbor-repo-info.md => harbor-repo-view.md} | 14 ++--- doc/cli-docs/harbor-repo.md | 7 ++- doc/cli-docs/harbor-schedule-list.md | 34 ++++++++++ doc/cli-docs/harbor-schedule.md | 29 +++++++++ doc/cli-docs/harbor-user-create.md | 4 +- doc/cli-docs/harbor-user-delete.md | 4 +- doc/cli-docs/harbor-user-elevate.md | 4 +- doc/cli-docs/harbor-user-list.md | 10 ++- doc/cli-docs/harbor-user.md | 4 +- doc/cli-docs/harbor-version.md | 4 +- doc/cli-docs/harbor.md | 7 ++- .../harbor-artifact-delete.1 | 16 +++-- .../harbor-artifact-list.1 | 32 +++++++--- .../harbor-artifact-scan-start.1 | 16 +++-- .../harbor-artifact-scan-stop.1 | 16 +++-- .../harbor-artifact-scan.1 | 16 +++-- .../harbor-artifact-tags-create.1 | 16 +++-- .../harbor-artifact-tags-delete.1 | 16 +++-- .../harbor-artifact-tags-list.1 | 16 +++-- .../harbor-artifact-tags.1 | 16 +++-- doc/man-docs/harbor-artifact-view.1 | 45 +++++++++++++ doc/{man_docs => man-docs}/harbor-artifact.1 | 18 +++--- doc/man-docs/harbor-health.1 | 45 +++++++++++++ doc/man-docs/harbor-label-create.1 | 61 ++++++++++++++++++ doc/man-docs/harbor-label-delete.1 | 49 +++++++++++++++ doc/man-docs/harbor-label-list.1 | 63 +++++++++++++++++++ doc/man-docs/harbor-label-update.1 | 61 ++++++++++++++++++ doc/man-docs/harbor-label.1 | 39 ++++++++++++ doc/{man_docs => man-docs}/harbor-login.1 | 20 +++--- .../harbor-project-create.1 | 24 +++---- .../harbor-project-delete.1 | 18 +++--- .../harbor-project-list.1 | 22 ++++--- .../harbor-project-logs.1 | 16 +++-- doc/man-docs/harbor-project-search.1 | 39 ++++++++++++ .../harbor-project-view.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-project.1 | 18 +++--- .../harbor-registry-create.1 | 26 ++++---- .../harbor-registry-delete.1 | 26 ++++---- .../harbor-registry-list.1 | 16 +++-- .../harbor-registry-update.1 | 32 +++++----- .../harbor-registry-view.1 | 26 ++++---- doc/{man_docs => man-docs}/harbor-registry.1 | 18 +++--- .../harbor-repo-delete.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-repo-list.1 | 24 ++++--- doc/man-docs/harbor-repo-search.1 | 39 ++++++++++++ .../harbor-repo-view.1} | 24 ++++--- doc/{man_docs => man-docs}/harbor-repo.1 | 18 +++--- doc/man-docs/harbor-schedule-list.1 | 47 ++++++++++++++ doc/man-docs/harbor-schedule.1 | 39 ++++++++++++ .../harbor-user-create.1 | 16 +++-- .../harbor-user-delete.1 | 16 +++-- .../harbor-user-elevate.1 | 16 +++-- doc/man-docs/harbor-user-list.1 | 55 ++++++++++++++++ doc/{man_docs => man-docs}/harbor-user.1 | 16 +++-- doc/{man_docs => man-docs}/harbor-version.1 | 16 +++-- doc/man-docs/harbor.1 | 50 +++++++++++++++ doc/man_docs/harbor-artifact-info.1 | 47 -------------- doc/man_docs/harbor-registry-info.1 | 41 ------------ doc/man_docs/harbor-user-list.1 | 41 ------------ doc/man_docs/harbor.1 | 51 --------------- 97 files changed, 1438 insertions(+), 681 deletions(-) delete mode 100644 doc/cli-docs/_index.md delete mode 100644 doc/cli-docs/harbor-artifact-info.md create mode 100644 doc/cli-docs/harbor-artifact-view.md create mode 100644 doc/cli-docs/harbor-label-create.md create mode 100644 doc/cli-docs/harbor-label-delete.md create mode 100644 doc/cli-docs/harbor-label-list.md create mode 100644 doc/cli-docs/harbor-label-update.md create mode 100644 doc/cli-docs/harbor-label.md create mode 100644 doc/cli-docs/harbor-project-search.md delete mode 100644 doc/cli-docs/harbor-registry-info.md create mode 100644 doc/cli-docs/harbor-repo-search.md rename doc/cli-docs/{harbor-repo-info.md => harbor-repo-view.md} (60%) create mode 100644 doc/cli-docs/harbor-schedule-list.md create mode 100644 doc/cli-docs/harbor-schedule.md rename doc/{man_docs => man-docs}/harbor-artifact-delete.1 (66%) rename doc/{man_docs => man-docs}/harbor-artifact-list.1 (51%) rename doc/{man_docs => man-docs}/harbor-artifact-scan-start.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-scan-stop.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-scan.1 (73%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-create.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-delete.1 (72%) rename doc/{man_docs => man-docs}/harbor-artifact-tags-list.1 (71%) rename doc/{man_docs => man-docs}/harbor-artifact-tags.1 (75%) create mode 100644 doc/man-docs/harbor-artifact-view.1 rename doc/{man_docs => man-docs}/harbor-artifact.1 (61%) create mode 100644 doc/man-docs/harbor-health.1 create mode 100644 doc/man-docs/harbor-label-create.1 create mode 100644 doc/man-docs/harbor-label-delete.1 create mode 100644 doc/man-docs/harbor-label-list.1 create mode 100644 doc/man-docs/harbor-label-update.1 create mode 100644 doc/man-docs/harbor-label.1 rename doc/{man_docs => man-docs}/harbor-login.1 (67%) rename doc/{man_docs => man-docs}/harbor-project-create.1 (67%) rename doc/{man_docs => man-docs}/harbor-project-delete.1 (60%) rename doc/{man_docs => man-docs}/harbor-project-list.1 (70%) rename doc/{man_docs => man-docs}/harbor-project-logs.1 (66%) create mode 100644 doc/man-docs/harbor-project-search.1 rename doc/{man_docs => man-docs}/harbor-project-view.1 (67%) rename doc/{man_docs => man-docs}/harbor-project.1 (67%) rename doc/{man_docs => man-docs}/harbor-registry-create.1 (73%) rename doc/{man_docs => man-docs}/harbor-registry-delete.1 (52%) rename doc/{man_docs => man-docs}/harbor-registry-list.1 (74%) rename doc/{man_docs => man-docs}/harbor-registry-update.1 (61%) rename doc/{man_docs => man-docs}/harbor-registry-view.1 (51%) rename doc/{man_docs => man-docs}/harbor-registry.1 (60%) rename doc/{man_docs => man-docs}/harbor-repo-delete.1 (71%) rename doc/{man_docs => man-docs}/harbor-repo-list.1 (56%) create mode 100644 doc/man-docs/harbor-repo-search.1 rename doc/{man_docs/harbor-repo-info.1 => man-docs/harbor-repo-view.1} (52%) rename doc/{man_docs => man-docs}/harbor-repo.1 (54%) create mode 100644 doc/man-docs/harbor-schedule-list.1 create mode 100644 doc/man-docs/harbor-schedule.1 rename doc/{man_docs => man-docs}/harbor-user-create.1 (72%) rename doc/{man_docs => man-docs}/harbor-user-delete.1 (65%) rename doc/{man_docs => man-docs}/harbor-user-elevate.1 (66%) create mode 100644 doc/man-docs/harbor-user-list.1 rename doc/{man_docs => man-docs}/harbor-user.1 (72%) rename doc/{man_docs => man-docs}/harbor-version.1 (71%) create mode 100644 doc/man-docs/harbor.1 delete mode 100644 doc/man_docs/harbor-artifact-info.1 delete mode 100644 doc/man_docs/harbor-registry-info.1 delete mode 100644 doc/man_docs/harbor-user-list.1 delete mode 100644 doc/man_docs/harbor.1 diff --git a/doc/cli-docs/_index.md b/doc/cli-docs/_index.md deleted file mode 100644 index 17c42a4d..00000000 --- a/doc/cli-docs/_index.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: Harbor CLI Commands -weight: 25 ---- - -This section describes the comprehensive set of commands provided by the Harbor CLI, which enables you to efficiently manage and interact with your Harbor registry. The Harbor CLI commands are categorized by function, - -- `harbor` - Configure the Harbor CLI and set global flags to customize your experience. -- `harbor artifact` - Manage artifacts in Harbor Repository -- `harbor project` - Manage projects and assign resources to them -- `harbor registry` - Manage registries in Harbor -- `harbor repo` - Manage repositories in Harbor context -- `harbor user` - Administer users in Harbor, including creating, updating, and managing user accounts \ No newline at end of file diff --git a/doc/cli-docs/harbor-artifact-delete.md b/doc/cli-docs/harbor-artifact-delete.md index fd4d9ca6..2661569c 100644 --- a/doc/cli-docs/harbor-artifact-delete.md +++ b/doc/cli-docs/harbor-artifact-delete.md @@ -1,6 +1,6 @@ --- title: harbor artifact delete -weight: 35 +weight: 85 --- ## harbor artifact delete @@ -21,7 +21,7 @@ harbor artifact delete [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-info.md b/doc/cli-docs/harbor-artifact-info.md deleted file mode 100644 index 55157e9a..00000000 --- a/doc/cli-docs/harbor-artifact-info.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: harbor artifact info -weight: 25 ---- -## harbor artifact info - -### Description - -##### Get info of an artifact - -### Synopsis - -Get info of an artifact - -```sh -harbor artifact info [flags] -``` - -### Examples - -```sh -harbor artifact info // -``` - -### Options - -```sh - -h, --help help for info -``` - -### Options inherited from parent commands - -```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") - -o, --output-format string Output format. One of: json|yaml - -v, --verbose verbose output -``` - -### SEE ALSO - -* [harbor artifact](harbor-artifact.md) - Manage artifacts - diff --git a/doc/cli-docs/harbor-artifact-list.md b/doc/cli-docs/harbor-artifact-list.md index dd02b30a..56065880 100644 --- a/doc/cli-docs/harbor-artifact-list.md +++ b/doc/cli-docs/harbor-artifact-list.md @@ -1,6 +1,6 @@ --- title: harbor artifact list -weight: 30 +weight: 35 --- ## harbor artifact list @@ -15,13 +15,17 @@ harbor artifact list [flags] ### Options ```sh - -h, --help help for list + -h, --help help for list + -p, --page int Page number (default 1) + -n, --page-size int Size of per page (default 10) + -q, --query string Query string to query resources + -s, --sort string Sort the resource list in ascending or descending order ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-scan-start.md b/doc/cli-docs/harbor-artifact-scan-start.md index 31652afe..8fa6eba9 100644 --- a/doc/cli-docs/harbor-artifact-scan-start.md +++ b/doc/cli-docs/harbor-artifact-scan-start.md @@ -1,6 +1,6 @@ --- title: harbor artifact scan start -weight: 45 +weight: 50 --- ## harbor artifact scan start @@ -31,7 +31,7 @@ harbor artifact scan start // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-scan-stop.md b/doc/cli-docs/harbor-artifact-scan-stop.md index 781c6ad2..79c4db59 100644 --- a/doc/cli-docs/harbor-artifact-scan-stop.md +++ b/doc/cli-docs/harbor-artifact-scan-stop.md @@ -1,6 +1,6 @@ --- title: harbor artifact scan stop -weight: 50 +weight: 90 --- ## harbor artifact scan stop @@ -31,7 +31,7 @@ harbor artifact scan stop // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-scan.md b/doc/cli-docs/harbor-artifact-scan.md index c5af733e..fe0da64e 100644 --- a/doc/cli-docs/harbor-artifact-scan.md +++ b/doc/cli-docs/harbor-artifact-scan.md @@ -1,6 +1,6 @@ --- title: harbor artifact scan -weight: 40 +weight: 80 --- ## harbor artifact scan @@ -27,7 +27,7 @@ harbor artifact scan start // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-tags-create.md b/doc/cli-docs/harbor-artifact-tags-create.md index 236c3d82..3e642abe 100644 --- a/doc/cli-docs/harbor-artifact-tags-create.md +++ b/doc/cli-docs/harbor-artifact-tags-create.md @@ -1,6 +1,6 @@ --- title: harbor artifact tags create -weight: 60 +weight: 50 --- ## harbor artifact tags create @@ -27,7 +27,7 @@ harbor artifact tags create // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-tags-delete.md b/doc/cli-docs/harbor-artifact-tags-delete.md index b5b2e15e..5317e11a 100644 --- a/doc/cli-docs/harbor-artifact-tags-delete.md +++ b/doc/cli-docs/harbor-artifact-tags-delete.md @@ -27,7 +27,7 @@ harbor artifact tags delete // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-tags-list.md b/doc/cli-docs/harbor-artifact-tags-list.md index 169ec950..02db0cfd 100644 --- a/doc/cli-docs/harbor-artifact-tags-list.md +++ b/doc/cli-docs/harbor-artifact-tags-list.md @@ -1,6 +1,6 @@ --- title: harbor artifact tags list -weight: 65 +weight: 25 --- ## harbor artifact tags list @@ -27,7 +27,7 @@ harbor artifact tags list // ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-tags.md b/doc/cli-docs/harbor-artifact-tags.md index 683dd452..460da1df 100644 --- a/doc/cli-docs/harbor-artifact-tags.md +++ b/doc/cli-docs/harbor-artifact-tags.md @@ -23,7 +23,7 @@ weight: 55 ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-artifact-view.md b/doc/cli-docs/harbor-artifact-view.md new file mode 100644 index 00000000..eb19d460 --- /dev/null +++ b/doc/cli-docs/harbor-artifact-view.md @@ -0,0 +1,42 @@ +--- +title: harbor artifact view +weight: 45 +--- +## harbor artifact view + +### Description + +##### Get information of an artifact + +### Synopsis + +Get information of an artifact + +```sh +harbor artifact view [flags] +``` + +### Examples + +```sh +harbor artifact view // +``` + +### Options + +```sh + -h, --help help for view +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor artifact](harbor-artifact.md) - Manage artifacts + diff --git a/doc/cli-docs/harbor-artifact.md b/doc/cli-docs/harbor-artifact.md index c267dae8..262039e0 100644 --- a/doc/cli-docs/harbor-artifact.md +++ b/doc/cli-docs/harbor-artifact.md @@ -1,6 +1,6 @@ --- title: harbor artifact -weight: 20 +weight: 40 --- ## harbor artifact @@ -27,7 +27,7 @@ Manage artifacts in Harbor Repository ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` @@ -36,8 +36,8 @@ Manage artifacts in Harbor Repository * [harbor](harbor.md) - Official Harbor CLI * [harbor artifact delete](harbor-artifact-delete.md) - delete an artifact -* [harbor artifact info](harbor-artifact-info.md) - Get info of an artifact * [harbor artifact list](harbor-artifact-list.md) - list artifacts within a repository * [harbor artifact scan](harbor-artifact-scan.md) - Scan an artifact * [harbor artifact tags](harbor-artifact-tags.md) - Manage tags of an artifact +* [harbor artifact view](harbor-artifact-view.md) - Get information of an artifact diff --git a/doc/cli-docs/harbor-health.md b/doc/cli-docs/harbor-health.md index b4ec960c..933574d6 100644 --- a/doc/cli-docs/harbor-health.md +++ b/doc/cli-docs/harbor-health.md @@ -1,6 +1,6 @@ --- title: harbor health -weight: 80 +weight: 30 --- ## harbor health @@ -27,7 +27,7 @@ harbor health [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/Users/vadim/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-label-create.md b/doc/cli-docs/harbor-label-create.md new file mode 100644 index 00000000..a724c472 --- /dev/null +++ b/doc/cli-docs/harbor-label-create.md @@ -0,0 +1,46 @@ +--- +title: harbor label create +weight: 20 +--- +## harbor label create + +### Description + +##### create label + +### Synopsis + +create label in harbor + +```sh +harbor label create [flags] +``` + +### Examples + +```sh +harbor label create +``` + +### Options + +```sh + --color string Color of the label.color is in hex value (default "#FFFFFF") + -d, --description string Description of the label + -h, --help help for create + -n, --name string Name of the label + -s, --scope string Scope of the label. eg- g(global), p(specific project) (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-delete.md b/doc/cli-docs/harbor-label-delete.md new file mode 100644 index 00000000..ce8ea7d4 --- /dev/null +++ b/doc/cli-docs/harbor-label-delete.md @@ -0,0 +1,39 @@ +--- +title: harbor label delete +weight: 60 +--- +## harbor label delete + +### Description + +##### delete label + +```sh +harbor label delete [flags] +``` + +### Examples + +```sh +harbor label delete [labelname] +``` + +### Options + +```sh + -h, --help help for delete + -s, --scope string default(global).'p' for project labels.Query scope of the label (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-list.md b/doc/cli-docs/harbor-label-list.md new file mode 100644 index 00000000..cdf183ff --- /dev/null +++ b/doc/cli-docs/harbor-label-list.md @@ -0,0 +1,38 @@ +--- +title: harbor label list +weight: 60 +--- +## harbor label list + +### Description + +##### list labels + +```sh +harbor label list [flags] +``` + +### Options + +```sh + -h, --help help for list + --page int Page number (default 1) + --page-size int Size of per page (default 20) + -i, --projectid int project ID when query project labels (default 1) + -q, --query string Query string to query resources + -s, --scope string default(global).'p' for project labels.Query scope of the label (default "g") + --sort string Sort the label list in ascending or descending order +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label-update.md b/doc/cli-docs/harbor-label-update.md new file mode 100644 index 00000000..e2072cfe --- /dev/null +++ b/doc/cli-docs/harbor-label-update.md @@ -0,0 +1,42 @@ +--- +title: harbor label update +weight: 70 +--- +## harbor label update + +### Description + +##### update label + +```sh +harbor label update [flags] +``` + +### Examples + +```sh +harbor label update [labelname] +``` + +### Options + +```sh + --color string Color of the label.color is in hex value + -d, --description string Description of the label + -h, --help help for update + -n, --name string Name of the label + -s, --scope string Scope of the label. eg- g(global), p(specific project) (default "g") +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor label](harbor-label.md) - Manage labels in Harbor + diff --git a/doc/cli-docs/harbor-label.md b/doc/cli-docs/harbor-label.md new file mode 100644 index 00000000..fa8a698b --- /dev/null +++ b/doc/cli-docs/harbor-label.md @@ -0,0 +1,32 @@ +--- +title: harbor label +weight: 70 +--- +## harbor label + +### Description + +##### Manage labels in Harbor + +### Options + +```sh + -h, --help help for label +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor](harbor.md) - Official Harbor CLI +* [harbor label create](harbor-label-create.md) - create label +* [harbor label delete](harbor-label-delete.md) - delete label +* [harbor label list](harbor-label-list.md) - list labels +* [harbor label update](harbor-label-update.md) - update label + diff --git a/doc/cli-docs/harbor-login.md b/doc/cli-docs/harbor-login.md index 4e401829..cb7f59f6 100644 --- a/doc/cli-docs/harbor-login.md +++ b/doc/cli-docs/harbor-login.md @@ -1,6 +1,6 @@ --- title: harbor login -weight: 15 +weight: 30 --- ## harbor login @@ -22,13 +22,14 @@ harbor login [server] [flags] -h, --help help for login --name string name for the set of credentials -p, --password string Password + --password-stdin Take the password from stdin -u, --username string Username ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project-create.md b/doc/cli-docs/harbor-project-create.md index fcea0a3c..2b3fc93c 100644 --- a/doc/cli-docs/harbor-project-create.md +++ b/doc/cli-docs/harbor-project-create.md @@ -1,6 +1,6 @@ --- title: harbor project create -weight: 80 +weight: 5 --- ## harbor project create @@ -9,16 +9,15 @@ weight: 80 ##### create project ```sh -harbor project create [flags] +harbor project create [project name] [flags] ``` ### Options ```sh -h, --help help for create - --name string Name of the project --proxy-cache Whether the project is a proxy cache project - --public Project is public or private (default true) + --public Project is public or private --registry-id string ID of referenced registry when creating the proxy cache project --storage-limit string Storage quota of the project (default "-1") ``` @@ -26,7 +25,7 @@ harbor project create [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project-delete.md b/doc/cli-docs/harbor-project-delete.md index fffdcf61..f6dedee7 100644 --- a/doc/cli-docs/harbor-project-delete.md +++ b/doc/cli-docs/harbor-project-delete.md @@ -1,6 +1,6 @@ --- title: harbor project delete -weight: 100 +weight: 40 --- ## harbor project delete @@ -15,13 +15,14 @@ harbor project delete [flags] ### Options ```sh - -h, --help help for delete + --force Deletes all repositories and artifacts within the project + -h, --help help for delete ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project-list.md b/doc/cli-docs/harbor-project-list.md index 41d6ed66..7aa6904c 100644 --- a/doc/cli-docs/harbor-project-list.md +++ b/doc/cli-docs/harbor-project-list.md @@ -1,6 +1,6 @@ --- title: harbor project list -weight: 85 +weight: 90 --- ## harbor project list @@ -19,7 +19,8 @@ harbor project list [flags] --name string Name of the project --page int Page number (default 1) --page-size int Size of per page (default 10) - --public Project is public or private + --private Show only private projects + --public Show only public projects -q, --query string Query string to query resources --sort string Sort the resource list in ascending or descending order ``` @@ -27,7 +28,7 @@ harbor project list [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project-logs.md b/doc/cli-docs/harbor-project-logs.md index c4d046ae..9a9348a5 100644 --- a/doc/cli-docs/harbor-project-logs.md +++ b/doc/cli-docs/harbor-project-logs.md @@ -1,6 +1,6 @@ --- title: harbor project logs -weight: 90 +weight: 10 --- ## harbor project logs @@ -21,7 +21,7 @@ harbor project logs [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project-search.md b/doc/cli-docs/harbor-project-search.md new file mode 100644 index 00000000..392cbbbd --- /dev/null +++ b/doc/cli-docs/harbor-project-search.md @@ -0,0 +1,32 @@ +--- +title: harbor project search +weight: 15 +--- +## harbor project search + +### Description + +##### search project based on their names + +```sh +harbor project search [flags] +``` + +### Options + +```sh + -h, --help help for search +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor project](harbor-project.md) - Manage projects and assign resources to them + diff --git a/doc/cli-docs/harbor-project-view.md b/doc/cli-docs/harbor-project-view.md index 968c7aba..1662003a 100644 --- a/doc/cli-docs/harbor-project-view.md +++ b/doc/cli-docs/harbor-project-view.md @@ -1,6 +1,6 @@ --- title: harbor project view -weight: 95 +weight: 15 --- ## harbor project view @@ -21,7 +21,7 @@ harbor project view [NAME|ID] [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-project.md b/doc/cli-docs/harbor-project.md index d18b6b55..b947b93a 100644 --- a/doc/cli-docs/harbor-project.md +++ b/doc/cli-docs/harbor-project.md @@ -1,6 +1,6 @@ --- title: harbor project -weight: 75 +weight: 35 --- ## harbor project @@ -27,7 +27,7 @@ Manage projects in Harbor ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` @@ -39,5 +39,6 @@ Manage projects in Harbor * [harbor project delete](harbor-project-delete.md) - delete project by name or id * [harbor project list](harbor-project-list.md) - list project * [harbor project logs](harbor-project-logs.md) - get project logs +* [harbor project search](harbor-project-search.md) - search project based on their names * [harbor project view](harbor-project-view.md) - get project by name or id diff --git a/doc/cli-docs/harbor-registry-create.md b/doc/cli-docs/harbor-registry-create.md index 99c6f31e..a3669917 100644 --- a/doc/cli-docs/harbor-registry-create.md +++ b/doc/cli-docs/harbor-registry-create.md @@ -1,6 +1,6 @@ --- title: harbor registry create -weight: 110 +weight: 35 --- ## harbor registry create @@ -12,6 +12,12 @@ weight: 110 harbor registry create [flags] ``` +### Examples + +```sh +harbor registry create +``` + ### Options ```sh @@ -20,16 +26,16 @@ harbor registry create [flags] --credential-type string Credential type, such as 'basic', 'oauth' (default "basic") --description string Description of the registry -h, --help help for create - --insecure Whether or not the certificate will be verified when Harbor tries to access the server (default true) + --insecure Whether Harbor will verify the server certificate (default true) --name string Name of the registry - --type string Type of the registry (default "harbor") + --type string Type of the registry --url string Registry endpoint URL ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-registry-delete.md b/doc/cli-docs/harbor-registry-delete.md index f0e1b0ee..60b88d3f 100644 --- a/doc/cli-docs/harbor-registry-delete.md +++ b/doc/cli-docs/harbor-registry-delete.md @@ -1,17 +1,23 @@ --- title: harbor registry delete -weight: 140 +weight: 10 --- ## harbor registry delete ### Description -##### delete registry by id +##### delete registry ```sh harbor registry delete [flags] ``` +### Examples + +```sh +harbor registry delete [registryname] +``` + ### Options ```sh @@ -21,7 +27,7 @@ harbor registry delete [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-registry-info.md b/doc/cli-docs/harbor-registry-info.md deleted file mode 100644 index 2fd7fc45..00000000 --- a/doc/cli-docs/harbor-registry-info.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: harbor registry info -weight: 120 ---- -## harbor registry info - -### Description - -##### get registry info - -```sh -harbor registry info [flags] -``` - -### Options - -```sh - -h, --help help for info -``` - -### Options inherited from parent commands - -```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") - -o, --output-format string Output format. One of: json|yaml - -v, --verbose verbose output -``` - -### SEE ALSO - -* [harbor registry](harbor-registry.md) - Manage registries - diff --git a/doc/cli-docs/harbor-registry-list.md b/doc/cli-docs/harbor-registry-list.md index 2a230059..fb512646 100644 --- a/doc/cli-docs/harbor-registry-list.md +++ b/doc/cli-docs/harbor-registry-list.md @@ -1,6 +1,6 @@ --- title: harbor registry list -weight: 115 +weight: 30 --- ## harbor registry list @@ -25,7 +25,7 @@ harbor registry list [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-registry-update.md b/doc/cli-docs/harbor-registry-update.md index 7c4a4302..e4fe4591 100644 --- a/doc/cli-docs/harbor-registry-update.md +++ b/doc/cli-docs/harbor-registry-update.md @@ -1,6 +1,6 @@ --- title: harbor registry update -weight: 125 +weight: 65 --- ## harbor registry update @@ -9,27 +9,27 @@ weight: 125 ##### update registry ```sh -harbor registry update [flags] +harbor registry update [registry_name] [flags] ``` ### Options ```sh - --credential-access-key string Access key, e.g. user name when credential type is 'basic' - --credential-access-secret string Access secret, e.g. password when credential type is 'basic' + -k, --credential-access-key string Access key, e.g. user name when credential type is 'basic' + -s, --credential-access-secret string Access secret, e.g. password when credential type is 'basic' --credential-type string Credential type, such as 'basic', 'oauth' - --description string Description of the registry + -d, --description string Description of the registry -h, --help help for update - --insecure Whether or not the certificate will be verified when Harbor tries to access the server (default true) - --name string Name of the registry - --type string Type of the registry - --url string Registry endpoint URL + -i, --insecure Whether or not the certificate will be verified when Harbor tries to access the server + -n, --name string Name of the registry + -t, --type string Type of the registry + -u, --url string Registry endpoint URL ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-registry-view.md b/doc/cli-docs/harbor-registry-view.md index 62451e95..84de9795 100644 --- a/doc/cli-docs/harbor-registry-view.md +++ b/doc/cli-docs/harbor-registry-view.md @@ -1,17 +1,23 @@ --- title: harbor registry view -weight: 130 +weight: 30 --- ## harbor registry view ### Description -##### get registry by id +##### get registry information ```sh harbor registry view [flags] ``` +### Examples + +```sh +harbor registry view [registryName] +``` + ### Options ```sh @@ -21,7 +27,7 @@ harbor registry view [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-registry.md b/doc/cli-docs/harbor-registry.md index ce862d95..ef668e02 100644 --- a/doc/cli-docs/harbor-registry.md +++ b/doc/cli-docs/harbor-registry.md @@ -1,6 +1,6 @@ --- title: harbor registry -weight: 105 +weight: 10 --- ## harbor registry @@ -27,7 +27,7 @@ Manage registries in Harbor ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` @@ -36,9 +36,8 @@ Manage registries in Harbor * [harbor](harbor.md) - Official Harbor CLI * [harbor registry create](harbor-registry-create.md) - create registry -* [harbor registry delete](harbor-registry-delete.md) - delete registry by id -* [harbor registry info](harbor-registry-info.md) - get registry info +* [harbor registry delete](harbor-registry-delete.md) - delete registry * [harbor registry list](harbor-registry-list.md) - list registry * [harbor registry update](harbor-registry-update.md) - update registry -* [harbor registry view](harbor-registry-view.md) - get registry by id +* [harbor registry view](harbor-registry-view.md) - get registry information diff --git a/doc/cli-docs/harbor-repo-delete.md b/doc/cli-docs/harbor-repo-delete.md index 36e3bc34..019dee5a 100644 --- a/doc/cli-docs/harbor-repo-delete.md +++ b/doc/cli-docs/harbor-repo-delete.md @@ -1,6 +1,6 @@ --- title: harbor repo delete -weight: 160 +weight: 90 --- ## harbor repo delete @@ -31,7 +31,7 @@ harbor repo delete [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-repo-list.md b/doc/cli-docs/harbor-repo-list.md index 5274a542..c06ae342 100644 --- a/doc/cli-docs/harbor-repo-list.md +++ b/doc/cli-docs/harbor-repo-list.md @@ -1,6 +1,6 @@ --- title: harbor repo list -weight: 150 +weight: 30 --- ## harbor repo list @@ -8,10 +8,20 @@ weight: 150 ##### list repositories within a project +### Synopsis + +Get information of all repositories in a project + ```sh harbor repo list [flags] ``` +### Examples + +```sh + harbor repo list +``` + ### Options ```sh @@ -21,7 +31,7 @@ harbor repo list [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-repo-search.md b/doc/cli-docs/harbor-repo-search.md new file mode 100644 index 00000000..227e6c72 --- /dev/null +++ b/doc/cli-docs/harbor-repo-search.md @@ -0,0 +1,32 @@ +--- +title: harbor repo search +weight: 25 +--- +## harbor repo search + +### Description + +##### search repository based on their names + +```sh +harbor repo search [flags] +``` + +### Options + +```sh + -h, --help help for search +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor repo](harbor-repo.md) - Manage repositories + diff --git a/doc/cli-docs/harbor-repo-info.md b/doc/cli-docs/harbor-repo-view.md similarity index 60% rename from doc/cli-docs/harbor-repo-info.md rename to doc/cli-docs/harbor-repo-view.md index e1aaaeaf..4bfe3024 100644 --- a/doc/cli-docs/harbor-repo-info.md +++ b/doc/cli-docs/harbor-repo-view.md @@ -1,8 +1,8 @@ --- -title: harbor repo info -weight: 155 +title: harbor repo view +weight: 40 --- -## harbor repo info +## harbor repo view ### Description @@ -13,25 +13,25 @@ weight: 155 Get information of a particular repository in a project ```sh -harbor repo info [flags] +harbor repo view [flags] ``` ### Examples ```sh - harbor repo info / + harbor repo view / ``` ### Options ```sh - -h, --help help for info + -h, --help help for view ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-repo.md b/doc/cli-docs/harbor-repo.md index 6a3538e7..c1db2a2c 100644 --- a/doc/cli-docs/harbor-repo.md +++ b/doc/cli-docs/harbor-repo.md @@ -1,6 +1,6 @@ --- title: harbor repo -weight: 145 +weight: 70 --- ## harbor repo @@ -21,7 +21,7 @@ Manage repositories in Harbor context ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` @@ -30,6 +30,7 @@ Manage repositories in Harbor context * [harbor](harbor.md) - Official Harbor CLI * [harbor repo delete](harbor-repo-delete.md) - Delete a repository -* [harbor repo info](harbor-repo-info.md) - Get repository information * [harbor repo list](harbor-repo-list.md) - list repositories within a project +* [harbor repo search](harbor-repo-search.md) - search repository based on their names +* [harbor repo view](harbor-repo-view.md) - Get repository information diff --git a/doc/cli-docs/harbor-schedule-list.md b/doc/cli-docs/harbor-schedule-list.md new file mode 100644 index 00000000..603a5a44 --- /dev/null +++ b/doc/cli-docs/harbor-schedule-list.md @@ -0,0 +1,34 @@ +--- +title: harbor schedule list +weight: 20 +--- +## harbor schedule list + +### Description + +##### show all schedule jobs in Harbor + +```sh +harbor schedule list [flags] +``` + +### Options + +```sh + -h, --help help for list + --page int Page number (default 1) + --page-size int Size of per page (default 10) +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor schedule](harbor-schedule.md) - Schedule jobs in Harbor + diff --git a/doc/cli-docs/harbor-schedule.md b/doc/cli-docs/harbor-schedule.md new file mode 100644 index 00000000..ae1241d3 --- /dev/null +++ b/doc/cli-docs/harbor-schedule.md @@ -0,0 +1,29 @@ +--- +title: harbor schedule +weight: 75 +--- +## harbor schedule + +### Description + +##### Schedule jobs in Harbor + +### Options + +```sh + -h, --help help for schedule +``` + +### Options inherited from parent commands + +```sh + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor](harbor.md) - Official Harbor CLI +* [harbor schedule list](harbor-schedule-list.md) - show all schedule jobs in Harbor + diff --git a/doc/cli-docs/harbor-user-create.md b/doc/cli-docs/harbor-user-create.md index 8337ac0a..d7a01d85 100644 --- a/doc/cli-docs/harbor-user-create.md +++ b/doc/cli-docs/harbor-user-create.md @@ -1,6 +1,6 @@ --- title: harbor user create -weight: 170 +weight: 85 --- ## harbor user create @@ -26,7 +26,7 @@ harbor user create [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-user-delete.md b/doc/cli-docs/harbor-user-delete.md index f443621f..2c0c6908 100644 --- a/doc/cli-docs/harbor-user-delete.md +++ b/doc/cli-docs/harbor-user-delete.md @@ -1,6 +1,6 @@ --- title: harbor user delete -weight: 185 +weight: 75 --- ## harbor user delete @@ -21,7 +21,7 @@ harbor user delete [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-user-elevate.md b/doc/cli-docs/harbor-user-elevate.md index 42011e8f..c8d32052 100644 --- a/doc/cli-docs/harbor-user-elevate.md +++ b/doc/cli-docs/harbor-user-elevate.md @@ -1,6 +1,6 @@ --- title: harbor user elevate -weight: 180 +weight: 25 --- ## harbor user elevate @@ -25,7 +25,7 @@ harbor user elevate [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-user-list.md b/doc/cli-docs/harbor-user-list.md index fed5f464..57c6426d 100644 --- a/doc/cli-docs/harbor-user-list.md +++ b/doc/cli-docs/harbor-user-list.md @@ -1,6 +1,6 @@ --- title: harbor user list -weight: 175 +weight: 75 --- ## harbor user list @@ -15,13 +15,17 @@ harbor user list [flags] ### Options ```sh - -h, --help help for list + -h, --help help for list + -p, --page int Page number (default 1) + -n, --page-size int Size of per page (default 10) + -q, --query string Query string to query resources + -s, --sort string Sort the resource list in ascending or descending order ``` ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-user.md b/doc/cli-docs/harbor-user.md index f41bb480..74895631 100644 --- a/doc/cli-docs/harbor-user.md +++ b/doc/cli-docs/harbor-user.md @@ -1,6 +1,6 @@ --- title: harbor user -weight: 165 +weight: 50 --- ## harbor user @@ -27,7 +27,7 @@ Manage users in Harbor ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor-version.md b/doc/cli-docs/harbor-version.md index e7fc4cc9..91ffaafa 100644 --- a/doc/cli-docs/harbor-version.md +++ b/doc/cli-docs/harbor-version.md @@ -1,6 +1,6 @@ --- title: harbor version -weight: 10 +weight: 60 --- ## harbor version @@ -31,7 +31,7 @@ harbor version [flags] ### Options inherited from parent commands ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output ``` diff --git a/doc/cli-docs/harbor.md b/doc/cli-docs/harbor.md index 5b7f98e8..05bb75e9 100644 --- a/doc/cli-docs/harbor.md +++ b/doc/cli-docs/harbor.md @@ -1,6 +1,6 @@ --- title: harbor -weight: 5 +weight: 25 --- ## harbor @@ -27,7 +27,7 @@ harbor help ### Options ```sh - --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml) -h, --help help for harbor -o, --output-format string Output format. One of: json|yaml -v, --verbose verbose output @@ -36,10 +36,13 @@ harbor help ### SEE ALSO * [harbor artifact](harbor-artifact.md) - Manage artifacts +* [harbor health](harbor-health.md) - Get the health status of Harbor components +* [harbor label](harbor-label.md) - Manage labels in Harbor * [harbor login](harbor-login.md) - Log in to Harbor registry * [harbor project](harbor-project.md) - Manage projects and assign resources to them * [harbor registry](harbor-registry.md) - Manage registries * [harbor repo](harbor-repo.md) - Manage repositories +* [harbor schedule](harbor-schedule.md) - Schedule jobs in Harbor * [harbor user](harbor-user.md) - Manage users * [harbor version](harbor-version.md) - Version of Harbor CLI diff --git a/doc/man_docs/harbor-artifact-delete.1 b/doc/man-docs/harbor-artifact-delete.1 similarity index 66% rename from doc/man_docs/harbor-artifact-delete.1 rename to doc/man-docs/harbor-artifact-delete.1 index 1db46c26..456da0d3 100644 --- a/doc/man_docs/harbor-artifact-delete.1 +++ b/doc/man-docs/harbor-artifact-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-delete - delete an artifact .SH SYNOPSIS -.PP \fBharbor artifact delete [flags]\fP .SH DESCRIPTION -.PP delete an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ delete an artifact .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-list.1 b/doc/man-docs/harbor-artifact-list.1 similarity index 51% rename from doc/man_docs/harbor-artifact-list.1 rename to doc/man-docs/harbor-artifact-list.1 index 315aad31..67171e05 100644 --- a/doc/man_docs/harbor-artifact-list.1 +++ b/doc/man-docs/harbor-artifact-list.1 @@ -1,31 +1,42 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-list - list artifacts within a repository .SH SYNOPSIS -.PP \fBharbor artifact list [flags]\fP .SH DESCRIPTION -.PP list artifacts within a repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list +.PP +\fB-p\fP, \fB--page\fP=1 + Page number + +.PP +\fB-n\fP, \fB--page-size\fP=10 + Size of per page -.SH OPTIONS INHERITED FROM PARENT COMMANDS .PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +48,8 @@ list artifacts within a repository .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan-start.1 b/doc/man-docs/harbor-artifact-scan-start.1 similarity index 72% rename from doc/man_docs/harbor-artifact-scan-start.1 rename to doc/man-docs/harbor-artifact-scan-start.1 index 453e0c50..db9e4725 100644 --- a/doc/man_docs/harbor-artifact-scan-start.1 +++ b/doc/man-docs/harbor-artifact-scan-start.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan-start - Start a scan of an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan start [flags]\fP .SH DESCRIPTION -.PP Start a scan of an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for start .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan start // .SH SEE ALSO -.PP \fBharbor-artifact-scan(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan-stop.1 b/doc/man-docs/harbor-artifact-scan-stop.1 similarity index 72% rename from doc/man_docs/harbor-artifact-scan-stop.1 rename to doc/man-docs/harbor-artifact-scan-stop.1 index 1e105f46..2ee7effe 100644 --- a/doc/man_docs/harbor-artifact-scan-stop.1 +++ b/doc/man-docs/harbor-artifact-scan-stop.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan-stop - Stop a scan of an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan stop [flags]\fP .SH DESCRIPTION -.PP Stop a scan of an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for stop .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan stop // .SH SEE ALSO -.PP \fBharbor-artifact-scan(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-scan.1 b/doc/man-docs/harbor-artifact-scan.1 similarity index 73% rename from doc/man_docs/harbor-artifact-scan.1 rename to doc/man-docs/harbor-artifact-scan.1 index 4fc13c45..f180388e 100644 --- a/doc/man_docs/harbor-artifact-scan.1 +++ b/doc/man-docs/harbor-artifact-scan.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-scan - Scan an artifact .SH SYNOPSIS -.PP \fBharbor artifact scan [flags]\fP .SH DESCRIPTION -.PP Scan an artifact in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for scan .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact scan start // .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP, \fBharbor-artifact-scan-start(1)\fP, \fBharbor-artifact-scan-stop(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-create.1 b/doc/man-docs/harbor-artifact-tags-create.1 similarity index 72% rename from doc/man_docs/harbor-artifact-tags-create.1 rename to doc/man-docs/harbor-artifact-tags-create.1 index a2d74c03..dbef583a 100644 --- a/doc/man_docs/harbor-artifact-tags-create.1 +++ b/doc/man-docs/harbor-artifact-tags-create.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-create - Create a tag of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags create [flags]\fP .SH DESCRIPTION -.PP Create a tag of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for create .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags create // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-delete.1 b/doc/man-docs/harbor-artifact-tags-delete.1 similarity index 72% rename from doc/man_docs/harbor-artifact-tags-delete.1 rename to doc/man-docs/harbor-artifact-tags-delete.1 index 5227d295..f130c712 100644 --- a/doc/man_docs/harbor-artifact-tags-delete.1 +++ b/doc/man-docs/harbor-artifact-tags-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-delete - Delete a tag of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags delete [flags]\fP .SH DESCRIPTION -.PP Delete a tag of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags delete // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags-list.1 b/doc/man-docs/harbor-artifact-tags-list.1 similarity index 71% rename from doc/man_docs/harbor-artifact-tags-list.1 rename to doc/man-docs/harbor-artifact-tags-list.1 index 4d07a853..f0f5d9bc 100644 --- a/doc/man_docs/harbor-artifact-tags-list.1 +++ b/doc/man-docs/harbor-artifact-tags-list.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags-list - List tags of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags list [flags]\fP .SH DESCRIPTION -.PP List tags of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ harbor artifact tags list // .SH SEE ALSO -.PP \fBharbor-artifact-tags(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-tags.1 b/doc/man-docs/harbor-artifact-tags.1 similarity index 75% rename from doc/man_docs/harbor-artifact-tags.1 rename to doc/man-docs/harbor-artifact-tags.1 index 3ddf8bba..862010d8 100644 --- a/doc/man_docs/harbor-artifact-tags.1 +++ b/doc/man-docs/harbor-artifact-tags.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact-tags - Manage tags of an artifact .SH SYNOPSIS -.PP \fBharbor artifact tags [flags]\fP .SH DESCRIPTION -.PP Manage tags of an artifact .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for tags .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage tags of an artifact .SH SEE ALSO -.PP \fBharbor-artifact(1)\fP, \fBharbor-artifact-tags-create(1)\fP, \fBharbor-artifact-tags-delete(1)\fP, \fBharbor-artifact-tags-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-artifact-view.1 b/doc/man-docs/harbor-artifact-view.1 new file mode 100644 index 00000000..690b50ee --- /dev/null +++ b/doc/man-docs/harbor-artifact-view.1 @@ -0,0 +1,45 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-artifact-view - Get information of an artifact + + +.SH SYNOPSIS +\fBharbor artifact view [flags]\fP + + +.SH DESCRIPTION +Get information of an artifact + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for view + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor artifact view // +.EE + + +.SH SEE ALSO +\fBharbor-artifact(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact.1 b/doc/man-docs/harbor-artifact.1 similarity index 61% rename from doc/man_docs/harbor-artifact.1 rename to doc/man-docs/harbor-artifact.1 index 55ac01d3..488d53de 100644 --- a/doc/man_docs/harbor-artifact.1 +++ b/doc/man-docs/harbor-artifact.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-artifact - Manage artifacts .SH SYNOPSIS -.PP \fBharbor artifact [flags]\fP .SH DESCRIPTION -.PP Manage artifacts in Harbor Repository .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for artifact .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage artifacts in Harbor Repository .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-artifact-delete(1)\fP, \fBharbor-artifact-info(1)\fP, \fBharbor-artifact-list(1)\fP, \fBharbor-artifact-scan(1)\fP, \fBharbor-artifact-tags(1)\fP +\fBharbor(1)\fP, \fBharbor-artifact-delete(1)\fP, \fBharbor-artifact-list(1)\fP, \fBharbor-artifact-scan(1)\fP, \fBharbor-artifact-tags(1)\fP, \fBharbor-artifact-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-health.1 b/doc/man-docs/harbor-health.1 new file mode 100644 index 00000000..94069453 --- /dev/null +++ b/doc/man-docs/harbor-health.1 @@ -0,0 +1,45 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-health - Get the health status of Harbor components + + +.SH SYNOPSIS +\fBharbor health [flags]\fP + + +.SH DESCRIPTION +Get the health status of Harbor components + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for health + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + # Get the health status of Harbor components +.EE + + +.SH SEE ALSO +\fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-create.1 b/doc/man-docs/harbor-label-create.1 new file mode 100644 index 00000000..5b79a085 --- /dev/null +++ b/doc/man-docs/harbor-label-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-create - create label + + +.SH SYNOPSIS +\fBharbor label create [flags]\fP + + +.SH DESCRIPTION +create label in harbor + + +.SH OPTIONS +\fB--color\fP="#FFFFFF" + Color of the label.color is in hex value + +.PP +\fB-d\fP, \fB--description\fP="" + Description of the label + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB-n\fP, \fB--name\fP="" + Name of the label + +.PP +\fB-s\fP, \fB--scope\fP="g" + Scope of the label. eg- g(global), p(specific project) + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label create +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-delete.1 b/doc/man-docs/harbor-label-delete.1 new file mode 100644 index 00000000..baffb260 --- /dev/null +++ b/doc/man-docs/harbor-label-delete.1 @@ -0,0 +1,49 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-delete - delete label + + +.SH SYNOPSIS +\fBharbor label delete [flags]\fP + + +.SH DESCRIPTION +delete label + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for delete + +.PP +\fB-s\fP, \fB--scope\fP="g" + default(global).'p' for project labels.Query scope of the label + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label delete [labelname] +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-list.1 b/doc/man-docs/harbor-label-list.1 new file mode 100644 index 00000000..36dd243f --- /dev/null +++ b/doc/man-docs/harbor-label-list.1 @@ -0,0 +1,63 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-list - list labels + + +.SH SYNOPSIS +\fBharbor label list [flags]\fP + + +.SH DESCRIPTION +list labels + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=20 + Size of per page + +.PP +\fB-i\fP, \fB--projectid\fP=1 + project ID when query project labels + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--scope\fP="g" + default(global).'p' for project labels.Query scope of the label + +.PP +\fB--sort\fP="" + Sort the label list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label-update.1 b/doc/man-docs/harbor-label-update.1 new file mode 100644 index 00000000..39fa1556 --- /dev/null +++ b/doc/man-docs/harbor-label-update.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label-update - update label + + +.SH SYNOPSIS +\fBharbor label update [flags]\fP + + +.SH DESCRIPTION +update label + + +.SH OPTIONS +\fB--color\fP="" + Color of the label.color is in hex value + +.PP +\fB-d\fP, \fB--description\fP="" + Description of the label + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for update + +.PP +\fB-n\fP, \fB--name\fP="" + Name of the label + +.PP +\fB-s\fP, \fB--scope\fP="g" + Scope of the label. eg- g(global), p(specific project) + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX +harbor label update [labelname] +.EE + + +.SH SEE ALSO +\fBharbor-label(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-label.1 b/doc/man-docs/harbor-label.1 new file mode 100644 index 00000000..83566bba --- /dev/null +++ b/doc/man-docs/harbor-label.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-label - Manage labels in Harbor + + +.SH SYNOPSIS +\fBharbor label [flags]\fP + + +.SH DESCRIPTION +Manage labels in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for label + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor(1)\fP, \fBharbor-label-create(1)\fP, \fBharbor-label-delete(1)\fP, \fBharbor-label-list(1)\fP, \fBharbor-label-update(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-login.1 b/doc/man-docs/harbor-login.1 similarity index 67% rename from doc/man_docs/harbor-login.1 rename to doc/man-docs/harbor-login.1 index 015946a6..1a7224f0 100644 --- a/doc/man_docs/harbor-login.1 +++ b/doc/man-docs/harbor-login.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-login - Log in to Harbor registry .SH SYNOPSIS -.PP \fBharbor login [server] [flags]\fP .SH DESCRIPTION -.PP Authenticate with Harbor Registry. .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for login @@ -29,15 +25,18 @@ Authenticate with Harbor Registry. \fB-p\fP, \fB--password\fP="" Password +.PP +\fB--password-stdin\fP[=false] + Take the password from stdin + .PP \fB-u\fP, \fB--username\fP="" Username .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -49,5 +48,8 @@ Authenticate with Harbor Registry. .SH SEE ALSO -.PP \fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-create.1 b/doc/man-docs/harbor-project-create.1 similarity index 67% rename from doc/man_docs/harbor-project-create.1 rename to doc/man-docs/harbor-project-create.1 index ed05c0e1..ec1c9926 100644 --- a/doc/man_docs/harbor-project-create.1 +++ b/doc/man-docs/harbor-project-create.1 @@ -1,37 +1,29 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-create - create project .SH SYNOPSIS -.PP -\fBharbor project create [flags]\fP +\fBharbor project create [project name] [flags]\fP .SH DESCRIPTION -.PP create project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for create -.PP -\fB--name\fP="" - Name of the project - .PP \fB--proxy-cache\fP[=false] Whether the project is a proxy cache project .PP \fB--public\fP[=false] - Project is public or private. Private by default + Project is public or private .PP \fB--registry-id\fP="" @@ -43,9 +35,8 @@ create project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -57,5 +48,8 @@ create project .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-delete.1 b/doc/man-docs/harbor-project-delete.1 similarity index 60% rename from doc/man_docs/harbor-project-delete.1 rename to doc/man-docs/harbor-project-delete.1 index 80d67878..8894e565 100644 --- a/doc/man_docs/harbor-project-delete.1 +++ b/doc/man-docs/harbor-project-delete.1 @@ -1,31 +1,30 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-delete - delete project by name or id .SH SYNOPSIS -.PP \fBharbor project delete [flags]\fP .SH DESCRIPTION -.PP delete project by name or id .SH OPTIONS +\fB--force\fP[=false] + Deletes all repositories and artifacts within the project + .PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +36,8 @@ delete project by name or id .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-list.1 b/doc/man-docs/harbor-project-list.1 similarity index 70% rename from doc/man_docs/harbor-project-list.1 rename to doc/man-docs/harbor-project-list.1 index 198a6561..22f647fb 100644 --- a/doc/man_docs/harbor-project-list.1 +++ b/doc/man-docs/harbor-project-list.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-list - list project .SH SYNOPSIS -.PP \fBharbor project list [flags]\fP .SH DESCRIPTION -.PP list project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list @@ -33,9 +29,13 @@ list project \fB--page-size\fP=10 Size of per page +.PP +\fB--private\fP[=false] + Show only private projects + .PP \fB--public\fP[=false] - Project is public or private + Show only public projects .PP \fB-q\fP, \fB--query\fP="" @@ -47,9 +47,8 @@ list project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -61,5 +60,8 @@ list project .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-logs.1 b/doc/man-docs/harbor-project-logs.1 similarity index 66% rename from doc/man_docs/harbor-project-logs.1 rename to doc/man-docs/harbor-project-logs.1 index 6293920e..767e306b 100644 --- a/doc/man_docs/harbor-project-logs.1 +++ b/doc/man-docs/harbor-project-logs.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-logs - get project logs .SH SYNOPSIS -.PP \fBharbor project logs [flags]\fP .SH DESCRIPTION -.PP get project logs .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for logs .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ get project logs .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-project-search.1 b/doc/man-docs/harbor-project-search.1 new file mode 100644 index 00000000..ec8483aa --- /dev/null +++ b/doc/man-docs/harbor-project-search.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-project-search - search project based on their names + + +.SH SYNOPSIS +\fBharbor project search [flags]\fP + + +.SH DESCRIPTION +search project based on their names + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for search + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project-view.1 b/doc/man-docs/harbor-project-view.1 similarity index 67% rename from doc/man_docs/harbor-project-view.1 rename to doc/man-docs/harbor-project-view.1 index c987ed89..70fbab94 100644 --- a/doc/man_docs/harbor-project-view.1 +++ b/doc/man-docs/harbor-project-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project-view - get project by name or id .SH SYNOPSIS -.PP \fBharbor project view [NAME|ID] [flags]\fP .SH DESCRIPTION -.PP get project by name or id .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ get project by name or id .SH SEE ALSO -.PP \fBharbor-project(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-project.1 b/doc/man-docs/harbor-project.1 similarity index 67% rename from doc/man_docs/harbor-project.1 rename to doc/man-docs/harbor-project.1 index 19242e0d..3852fd59 100644 --- a/doc/man_docs/harbor-project.1 +++ b/doc/man-docs/harbor-project.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-project - Manage projects and assign resources to them .SH SYNOPSIS -.PP \fBharbor project [flags]\fP .SH DESCRIPTION -.PP Manage projects in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for project .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage projects in Harbor .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-project-create(1)\fP, \fBharbor-project-delete(1)\fP, \fBharbor-project-list(1)\fP, \fBharbor-project-logs(1)\fP, \fBharbor-project-view(1)\fP +\fBharbor(1)\fP, \fBharbor-project-create(1)\fP, \fBharbor-project-delete(1)\fP, \fBharbor-project-list(1)\fP, \fBharbor-project-logs(1)\fP, \fBharbor-project-search(1)\fP, \fBharbor-project-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-create.1 b/doc/man-docs/harbor-registry-create.1 similarity index 73% rename from doc/man_docs/harbor-registry-create.1 rename to doc/man-docs/harbor-registry-create.1 index ef6b4250..f202adaa 100644 --- a/doc/man_docs/harbor-registry-create.1 +++ b/doc/man-docs/harbor-registry-create.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-create - create registry .SH SYNOPSIS -.PP \fBharbor registry create [flags]\fP .SH DESCRIPTION -.PP create registry .SH OPTIONS -.PP \fB--credential-access-key\fP="" Access key, e.g. user name when credential type is 'basic' @@ -39,14 +35,14 @@ create registry .PP \fB--insecure\fP[=true] - Whether or not the certificate will be verified when Harbor tries to access the server + Whether Harbor will verify the server certificate .PP \fB--name\fP="" Name of the registry .PP -\fB--type\fP="harbor" +\fB--type\fP="" Type of the registry .PP @@ -55,9 +51,8 @@ create registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -68,6 +63,15 @@ create registry verbose output +.SH EXAMPLE +.EX +harbor registry create +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-delete.1 b/doc/man-docs/harbor-registry-delete.1 similarity index 52% rename from doc/man_docs/harbor-registry-delete.1 rename to doc/man-docs/harbor-registry-delete.1 index 1b6e2a86..bc429e90 100644 --- a/doc/man_docs/harbor-registry-delete.1 +++ b/doc/man-docs/harbor-registry-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-registry-delete - delete registry by id +harbor-registry-delete - delete registry .SH SYNOPSIS -.PP \fBharbor registry delete [flags]\fP .SH DESCRIPTION -.PP -delete registry by id +delete registry .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ delete registry by id verbose output +.SH EXAMPLE +.EX +harbor registry delete [registryname] +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-list.1 b/doc/man-docs/harbor-registry-list.1 similarity index 74% rename from doc/man_docs/harbor-registry-list.1 rename to doc/man-docs/harbor-registry-list.1 index 696c4c90..4694e311 100644 --- a/doc/man_docs/harbor-registry-list.1 +++ b/doc/man-docs/harbor-registry-list.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-list - list registry .SH SYNOPSIS -.PP \fBharbor registry list [flags]\fP .SH DESCRIPTION -.PP list registry .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list @@ -39,9 +35,8 @@ list registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -53,5 +48,8 @@ list registry .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-update.1 b/doc/man-docs/harbor-registry-update.1 similarity index 61% rename from doc/man_docs/harbor-registry-update.1 rename to doc/man-docs/harbor-registry-update.1 index ef56aa43..9a1cdd6e 100644 --- a/doc/man_docs/harbor-registry-update.1 +++ b/doc/man-docs/harbor-registry-update.1 @@ -1,28 +1,24 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry-update - update registry .SH SYNOPSIS -.PP -\fBharbor registry update [flags]\fP +\fBharbor registry update [registry_name] [flags]\fP .SH DESCRIPTION -.PP update registry .SH OPTIONS -.PP -\fB--credential-access-key\fP="" +\fB-k\fP, \fB--credential-access-key\fP="" Access key, e.g. user name when credential type is 'basic' .PP -\fB--credential-access-secret\fP="" +\fB-s\fP, \fB--credential-access-secret\fP="" Access secret, e.g. password when credential type is 'basic' .PP @@ -30,7 +26,7 @@ update registry Credential type, such as 'basic', 'oauth' .PP -\fB--description\fP="" +\fB-d\fP, \fB--description\fP="" Description of the registry .PP @@ -38,26 +34,25 @@ update registry help for update .PP -\fB--insecure\fP[=true] +\fB-i\fP, \fB--insecure\fP[=false] Whether or not the certificate will be verified when Harbor tries to access the server .PP -\fB--name\fP="" +\fB-n\fP, \fB--name\fP="" Name of the registry .PP -\fB--type\fP="" +\fB-t\fP, \fB--type\fP="" Type of the registry .PP -\fB--url\fP="" +\fB-u\fP, \fB--url\fP="" Registry endpoint URL .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -69,5 +64,8 @@ update registry .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry-view.1 b/doc/man-docs/harbor-registry-view.1 similarity index 51% rename from doc/man_docs/harbor-registry-view.1 rename to doc/man-docs/harbor-registry-view.1 index ee94b57b..b4c725ee 100644 --- a/doc/man_docs/harbor-registry-view.1 +++ b/doc/man-docs/harbor-registry-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-registry-view - get registry by id +harbor-registry-view - get registry information .SH SYNOPSIS -.PP \fBharbor registry view [flags]\fP .SH DESCRIPTION -.PP -get registry by id +get registry information .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ get registry by id verbose output +.SH EXAMPLE +.EX +harbor registry view [registryName] +.EE + + .SH SEE ALSO -.PP \fBharbor-registry(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-registry.1 b/doc/man-docs/harbor-registry.1 similarity index 60% rename from doc/man_docs/harbor-registry.1 rename to doc/man-docs/harbor-registry.1 index 2675b79c..c6868c46 100644 --- a/doc/man_docs/harbor-registry.1 +++ b/doc/man-docs/harbor-registry.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-registry - Manage registries .SH SYNOPSIS -.PP \fBharbor registry [flags]\fP .SH DESCRIPTION -.PP Manage registries in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for registry .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage registries in Harbor .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-registry-create(1)\fP, \fBharbor-registry-delete(1)\fP, \fBharbor-registry-info(1)\fP, \fBharbor-registry-list(1)\fP, \fBharbor-registry-update(1)\fP, \fBharbor-registry-view(1)\fP +\fBharbor(1)\fP, \fBharbor-registry-create(1)\fP, \fBharbor-registry-delete(1)\fP, \fBharbor-registry-list(1)\fP, \fBharbor-registry-update(1)\fP, \fBharbor-registry-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-delete.1 b/doc/man-docs/harbor-repo-delete.1 similarity index 71% rename from doc/man_docs/harbor-repo-delete.1 rename to doc/man-docs/harbor-repo-delete.1 index 8ed1eeba..3f871754 100644 --- a/doc/man_docs/harbor-repo-delete.1 +++ b/doc/man-docs/harbor-repo-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo-delete - Delete a repository .SH SYNOPSIS -.PP \fBharbor repo delete [flags]\fP .SH DESCRIPTION -.PP Delete a repository within a project in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Delete a repository within a project in Harbor .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-list.1 b/doc/man-docs/harbor-repo-list.1 similarity index 56% rename from doc/man_docs/harbor-repo-list.1 rename to doc/man-docs/harbor-repo-list.1 index c1d12ee3..473db8c4 100644 --- a/doc/man_docs/harbor-repo-list.1 +++ b/doc/man-docs/harbor-repo-list.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo-list - list repositories within a project .SH SYNOPSIS -.PP \fBharbor repo list [flags]\fP .SH DESCRIPTION -.PP -list repositories within a project +Get information of all repositories in a project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for list .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -36,6 +31,15 @@ list repositories within a project verbose output +.SH EXAMPLE +.EX + harbor repo list +.EE + + .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-repo-search.1 b/doc/man-docs/harbor-repo-search.1 new file mode 100644 index 00000000..99eb69f2 --- /dev/null +++ b/doc/man-docs/harbor-repo-search.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-repo-search - search repository based on their names + + +.SH SYNOPSIS +\fBharbor repo search [flags]\fP + + +.SH DESCRIPTION +search repository based on their names + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for search + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo-info.1 b/doc/man-docs/harbor-repo-view.1 similarity index 52% rename from doc/man_docs/harbor-repo-info.1 rename to doc/man-docs/harbor-repo-view.1 index a6dba505..231b8879 100644 --- a/doc/man_docs/harbor-repo-info.1 +++ b/doc/man-docs/harbor-repo-view.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP -harbor-repo-info - Get repository information +harbor-repo-view - Get repository information .SH SYNOPSIS -.PP -\fBharbor repo info [flags]\fP +\fBharbor repo view [flags]\fP .SH DESCRIPTION -.PP Get information of a particular repository in a project .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] - help for info + help for view .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -38,10 +33,13 @@ Get information of a particular repository in a project .SH EXAMPLE .EX - harbor repo info / + harbor repo view / .EE .SH SEE ALSO -.PP \fBharbor-repo(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-repo.1 b/doc/man-docs/harbor-repo.1 similarity index 54% rename from doc/man_docs/harbor-repo.1 rename to doc/man-docs/harbor-repo.1 index 6f561d0c..052f6739 100644 --- a/doc/man_docs/harbor-repo.1 +++ b/doc/man-docs/harbor-repo.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-repo - Manage repositories .SH SYNOPSIS -.PP \fBharbor repo [flags]\fP .SH DESCRIPTION -.PP Manage repositories in Harbor context .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for repo .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ Manage repositories in Harbor context .SH SEE ALSO -.PP -\fBharbor(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-info(1)\fP, \fBharbor-repo-list(1)\fP +\fBharbor(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-list(1)\fP, \fBharbor-repo-search(1)\fP, \fBharbor-repo-view(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-schedule-list.1 b/doc/man-docs/harbor-schedule-list.1 new file mode 100644 index 00000000..c6b8df09 --- /dev/null +++ b/doc/man-docs/harbor-schedule-list.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-schedule-list - show all schedule jobs in Harbor + + +.SH SYNOPSIS +\fBharbor schedule list [flags]\fP + + +.SH DESCRIPTION +show all schedule jobs in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-schedule(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-schedule.1 b/doc/man-docs/harbor-schedule.1 new file mode 100644 index 00000000..43cd0b92 --- /dev/null +++ b/doc/man-docs/harbor-schedule.1 @@ -0,0 +1,39 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-schedule - Schedule jobs in Harbor + + +.SH SYNOPSIS +\fBharbor schedule [flags]\fP + + +.SH DESCRIPTION +Schedule jobs in Harbor + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for schedule + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor(1)\fP, \fBharbor-schedule-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-create.1 b/doc/man-docs/harbor-user-create.1 similarity index 72% rename from doc/man_docs/harbor-user-create.1 rename to doc/man-docs/harbor-user-create.1 index 9934fbd7..46594581 100644 --- a/doc/man_docs/harbor-user-create.1 +++ b/doc/man-docs/harbor-user-create.1 @@ -1,23 +1,19 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-create - create user .SH SYNOPSIS -.PP \fBharbor user create [flags]\fP .SH DESCRIPTION -.PP create user .SH OPTIONS -.PP \fB--comment\fP="" Comment @@ -43,9 +39,8 @@ create user .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -57,5 +52,8 @@ create user .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-delete.1 b/doc/man-docs/harbor-user-delete.1 similarity index 65% rename from doc/man_docs/harbor-user-delete.1 rename to doc/man-docs/harbor-user-delete.1 index 372ae297..32f36ab6 100644 --- a/doc/man_docs/harbor-user-delete.1 +++ b/doc/man-docs/harbor-user-delete.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-delete - delete user .SH SYNOPSIS -.PP \fBharbor user delete [flags]\fP .SH DESCRIPTION -.PP delete user .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for delete .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ delete user .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user-elevate.1 b/doc/man-docs/harbor-user-elevate.1 similarity index 66% rename from doc/man_docs/harbor-user-elevate.1 rename to doc/man-docs/harbor-user-elevate.1 index 3bc57ac4..1dc19278 100644 --- a/doc/man_docs/harbor-user-elevate.1 +++ b/doc/man-docs/harbor-user-elevate.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user-elevate - elevate user .SH SYNOPSIS -.PP \fBharbor user elevate [flags]\fP .SH DESCRIPTION -.PP elevate user to admin role .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for elevate .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -37,5 +32,8 @@ elevate user to admin role .SH SEE ALSO -.PP \fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor-user-list.1 b/doc/man-docs/harbor-user-list.1 new file mode 100644 index 00000000..2c25bc2e --- /dev/null +++ b/doc/man-docs/harbor-user-list.1 @@ -0,0 +1,55 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor-user-list - list users + + +.SH SYNOPSIS +\fBharbor user list [flags]\fP + + +.SH DESCRIPTION +list users + + +.SH OPTIONS +\fB-h\fP, \fB--help\fP[=false] + help for list + +.PP +\fB-p\fP, \fB--page\fP=1 + Page number + +.PP +\fB-n\fP, \fB--page-size\fP=10 + Size of per page + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB-s\fP, \fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.SH OPTIONS INHERITED FROM PARENT COMMANDS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH SEE ALSO +\fBharbor-user(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-user.1 b/doc/man-docs/harbor-user.1 similarity index 72% rename from doc/man_docs/harbor-user.1 rename to doc/man-docs/harbor-user.1 index bde84e51..3407a95d 100644 --- a/doc/man_docs/harbor-user.1 +++ b/doc/man-docs/harbor-user.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-user - Manage users .SH SYNOPSIS -.PP \fBharbor user [flags]\fP .SH DESCRIPTION -.PP Manage users in Harbor .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for user .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Manage users in Harbor .SH SEE ALSO -.PP \fBharbor(1)\fP, \fBharbor-user-create(1)\fP, \fBharbor-user-delete(1)\fP, \fBharbor-user-elevate(1)\fP, \fBharbor-user-list(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-version.1 b/doc/man-docs/harbor-version.1 similarity index 71% rename from doc/man_docs/harbor-version.1 rename to doc/man-docs/harbor-version.1 index 90d60b02..0d80ae1c 100644 --- a/doc/man_docs/harbor-version.1 +++ b/doc/man-docs/harbor-version.1 @@ -1,31 +1,26 @@ .nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" .SH NAME -.PP harbor-version - Version of Harbor CLI .SH SYNOPSIS -.PP \fBharbor version [flags]\fP .SH DESCRIPTION -.PP Get Harbor CLI version, git commit, go version, build time, release channel, os/arch, etc. .SH OPTIONS -.PP \fB-h\fP, \fB--help\fP[=false] help for version .SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) .PP \fB-o\fP, \fB--output-format\fP="" @@ -43,5 +38,8 @@ Get Harbor CLI version, git commit, go version, build time, release channel, os/ .SH SEE ALSO -.PP \fBharbor(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man-docs/harbor.1 b/doc/man-docs/harbor.1 new file mode 100644 index 00000000..4675cbe5 --- /dev/null +++ b/doc/man-docs/harbor.1 @@ -0,0 +1,50 @@ +.nh +.TH "HARBOR" "1" "Dec 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +harbor - Official Harbor CLI + + +.SH SYNOPSIS +\fBharbor [flags]\fP + + +.SH DESCRIPTION +Official Harbor CLI + + +.SH OPTIONS +\fB-c\fP, \fB--config\fP="" + config file (default is $HOME/.config/harbor-cli/config.yaml) + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for harbor + +.PP +\fB-o\fP, \fB--output-format\fP="" + Output format. One of: json|yaml + +.PP +\fB-v\fP, \fB--verbose\fP[=false] + verbose output + + +.SH EXAMPLE +.EX + +// Base command: +harbor + +// Display help about the command: +harbor help + +.EE + + +.SH SEE ALSO +\fBharbor-artifact(1)\fP, \fBharbor-health(1)\fP, \fBharbor-label(1)\fP, \fBharbor-login(1)\fP, \fBharbor-project(1)\fP, \fBharbor-registry(1)\fP, \fBharbor-repo(1)\fP, \fBharbor-schedule(1)\fP, \fBharbor-user(1)\fP, \fBharbor-version(1)\fP + + +.SH HISTORY +28-Dec-2024 Auto generated by spf13/cobra diff --git a/doc/man_docs/harbor-artifact-info.1 b/doc/man_docs/harbor-artifact-info.1 deleted file mode 100644 index 16be12b2..00000000 --- a/doc/man_docs/harbor-artifact-info.1 +++ /dev/null @@ -1,47 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-artifact-info - Get info of an artifact - - -.SH SYNOPSIS -.PP -\fBharbor artifact info [flags]\fP - - -.SH DESCRIPTION -.PP -Get info of an artifact - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for info - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH EXAMPLE -.EX -harbor artifact info // -.EE - - -.SH SEE ALSO -.PP -\fBharbor-artifact(1)\fP diff --git a/doc/man_docs/harbor-registry-info.1 b/doc/man_docs/harbor-registry-info.1 deleted file mode 100644 index 69ef357a..00000000 --- a/doc/man_docs/harbor-registry-info.1 +++ /dev/null @@ -1,41 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-registry-info - get registry info - - -.SH SYNOPSIS -.PP -\fBharbor registry info [flags]\fP - - -.SH DESCRIPTION -.PP -get registry info - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for info - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH SEE ALSO -.PP -\fBharbor-registry(1)\fP diff --git a/doc/man_docs/harbor-user-list.1 b/doc/man_docs/harbor-user-list.1 deleted file mode 100644 index e3f4cdaa..00000000 --- a/doc/man_docs/harbor-user-list.1 +++ /dev/null @@ -1,41 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor-user-list - list users - - -.SH SYNOPSIS -.PP -\fBharbor user list [flags]\fP - - -.SH DESCRIPTION -.PP -list users - - -.SH OPTIONS -.PP -\fB-h\fP, \fB--help\fP[=false] - help for list - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH SEE ALSO -.PP -\fBharbor-user(1)\fP diff --git a/doc/man_docs/harbor.1 b/doc/man_docs/harbor.1 deleted file mode 100644 index fa20a67c..00000000 --- a/doc/man_docs/harbor.1 +++ /dev/null @@ -1,51 +0,0 @@ -.nh -.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" - -.SH NAME -.PP -harbor - Official Harbor CLI - - -.SH SYNOPSIS -.PP -\fBharbor [flags]\fP - - -.SH DESCRIPTION -.PP -Official Harbor CLI - - -.SH OPTIONS -.PP -\fB--config\fP="/home/bupd/.harbor/config.yaml" - config file (default is $HOME/.harbor/config.yaml) - -.PP -\fB-h\fP, \fB--help\fP[=false] - help for harbor - -.PP -\fB-o\fP, \fB--output-format\fP="" - Output format. One of: json|yaml - -.PP -\fB-v\fP, \fB--verbose\fP[=false] - verbose output - - -.SH EXAMPLE -.EX - -// Base command: -harbor - -// Display help about the command: -harbor help - -.EE - - -.SH SEE ALSO -.PP -\fBharbor-artifact(1)\fP, \fBharbor-login(1)\fP, \fBharbor-project(1)\fP, \fBharbor-registry(1)\fP, \fBharbor-repo(1)\fP, \fBharbor-user(1)\fP, \fBharbor-version(1)\fP