diff --git a/doc/man_docs/harbor-artifact-delete.1 b/doc/man_docs/harbor-artifact-delete.1 new file mode 100644 index 00000000..1db46c26 --- /dev/null +++ b/doc/man_docs/harbor-artifact-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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-artifact(1)\fP diff --git a/doc/man_docs/harbor-artifact-info.1 b/doc/man_docs/harbor-artifact-info.1 new file mode 100644 index 00000000..16be12b2 --- /dev/null +++ b/doc/man_docs/harbor-artifact-info.1 @@ -0,0 +1,47 @@ +.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-artifact-list.1 b/doc/man_docs/harbor-artifact-list.1 new file mode 100644 index 00000000..315aad31 --- /dev/null +++ b/doc/man_docs/harbor-artifact-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + + +.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-artifact(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan-start.1 b/doc/man_docs/harbor-artifact-scan-start.1 new file mode 100644 index 00000000..453e0c50 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan-start.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 scan start // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-scan(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan-stop.1 b/doc/man_docs/harbor-artifact-scan-stop.1 new file mode 100644 index 00000000..1e105f46 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan-stop.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 scan stop // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-scan(1)\fP diff --git a/doc/man_docs/harbor-artifact-scan.1 b/doc/man_docs/harbor-artifact-scan.1 new file mode 100644 index 00000000..4fc13c45 --- /dev/null +++ b/doc/man_docs/harbor-artifact-scan.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 scan start // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact(1)\fP, \fBharbor-artifact-scan-start(1)\fP, \fBharbor-artifact-scan-stop(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-create.1 b/doc/man_docs/harbor-artifact-tags-create.1 new file mode 100644 index 00000000..a2d74c03 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-create.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 tags create // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-delete.1 b/doc/man_docs/harbor-artifact-tags-delete.1 new file mode 100644 index 00000000..5227d295 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-delete.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 tags delete // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags-list.1 b/doc/man_docs/harbor-artifact-tags-list.1 new file mode 100644 index 00000000..4d07a853 --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags-list.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 tags list // +.EE + + +.SH SEE ALSO +.PP +\fBharbor-artifact-tags(1)\fP diff --git a/doc/man_docs/harbor-artifact-tags.1 b/doc/man_docs/harbor-artifact-tags.1 new file mode 100644 index 00000000..3ddf8bba --- /dev/null +++ b/doc/man_docs/harbor-artifact-tags.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 tags list // +.EE + + +.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 diff --git a/doc/man_docs/harbor-artifact.1 b/doc/man_docs/harbor-artifact.1 new file mode 100644 index 00000000..55ac01d3 --- /dev/null +++ b/doc/man_docs/harbor-artifact.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 list +.EE + + +.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 diff --git a/doc/man_docs/harbor-login.1 b/doc/man_docs/harbor-login.1 new file mode 100644 index 00000000..015946a6 --- /dev/null +++ b/doc/man_docs/harbor-login.1 @@ -0,0 +1,53 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + +.PP +\fB--name\fP="" + name for the set of credentials + +.PP +\fB-p\fP, \fB--password\fP="" + Password + +.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) + +.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(1)\fP diff --git a/doc/man_docs/harbor-project-create.1 b/doc/man_docs/harbor-project-create.1 new file mode 100644 index 00000000..ed05c0e1 --- /dev/null +++ b/doc/man_docs/harbor-project-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-project-create - create project + + +.SH SYNOPSIS +.PP +\fBharbor project create [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 + +.PP +\fB--registry-id\fP="" + ID of referenced registry when creating the proxy cache project + +.PP +\fB--storage-limit\fP="-1" + Storage quota of the project + + +.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-project(1)\fP diff --git a/doc/man_docs/harbor-project-delete.1 b/doc/man_docs/harbor-project-delete.1 new file mode 100644 index 00000000..80d67878 --- /dev/null +++ b/doc/man_docs/harbor-project-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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 +.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) + +.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-project(1)\fP diff --git a/doc/man_docs/harbor-project-list.1 b/doc/man_docs/harbor-project-list.1 new file mode 100644 index 00000000..198a6561 --- /dev/null +++ b/doc/man_docs/harbor-project-list.1 @@ -0,0 +1,65 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + +.PP +\fB--name\fP="" + Name of the project + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + +.PP +\fB--public\fP[=false] + Project is public or private + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.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-project(1)\fP diff --git a/doc/man_docs/harbor-project-logs.1 b/doc/man_docs/harbor-project-logs.1 new file mode 100644 index 00000000..6293920e --- /dev/null +++ b/doc/man_docs/harbor-project-logs.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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-project(1)\fP diff --git a/doc/man_docs/harbor-project-view.1 b/doc/man_docs/harbor-project-view.1 new file mode 100644 index 00000000..c987ed89 --- /dev/null +++ b/doc/man_docs/harbor-project-view.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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-project(1)\fP diff --git a/doc/man_docs/harbor-project.1 b/doc/man_docs/harbor-project.1 new file mode 100644 index 00000000..19242e0d --- /dev/null +++ b/doc/man_docs/harbor-project.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 project list +.EE + + +.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 diff --git a/doc/man_docs/harbor-registry-create.1 b/doc/man_docs/harbor-registry-create.1 new file mode 100644 index 00000000..ef6b4250 --- /dev/null +++ b/doc/man_docs/harbor-registry-create.1 @@ -0,0 +1,73 @@ +.nh +.TH "HARBOR" "1" "Jul 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' + +.PP +\fB--credential-access-secret\fP="" + Access secret, e.g. password when credential type is 'basic' + +.PP +\fB--credential-type\fP="basic" + Credential type, such as 'basic', 'oauth' + +.PP +\fB--description\fP="" + Description of the registry + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB--insecure\fP[=true] + Whether or not the certificate will be verified when Harbor tries to access the server + +.PP +\fB--name\fP="" + Name of the registry + +.PP +\fB--type\fP="harbor" + Type of the registry + +.PP +\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) + +.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-registry-delete.1 b/doc/man_docs/harbor-registry-delete.1 new file mode 100644 index 00000000..1b6e2a86 --- /dev/null +++ b/doc/man_docs/harbor-registry-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-delete - delete registry by id + + +.SH SYNOPSIS +.PP +\fBharbor registry delete [flags]\fP + + +.SH DESCRIPTION +.PP +delete registry by id + + +.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) + +.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-registry-info.1 b/doc/man_docs/harbor-registry-info.1 new file mode 100644 index 00000000..69ef357a --- /dev/null +++ b/doc/man_docs/harbor-registry-info.1 @@ -0,0 +1,41 @@ +.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-registry-list.1 b/doc/man_docs/harbor-registry-list.1 new file mode 100644 index 00000000..696c4c90 --- /dev/null +++ b/doc/man_docs/harbor-registry-list.1 @@ -0,0 +1,57 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + +.PP +\fB--page\fP=1 + Page number + +.PP +\fB--page-size\fP=10 + Size of per page + +.PP +\fB-q\fP, \fB--query\fP="" + Query string to query resources + +.PP +\fB--sort\fP="" + Sort the resource list in ascending or descending order + + +.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-registry-update.1 b/doc/man_docs/harbor-registry-update.1 new file mode 100644 index 00000000..ef56aa43 --- /dev/null +++ b/doc/man_docs/harbor-registry-update.1 @@ -0,0 +1,73 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-update - update registry + + +.SH SYNOPSIS +.PP +\fBharbor registry update [flags]\fP + + +.SH DESCRIPTION +.PP +update registry + + +.SH OPTIONS +.PP +\fB--credential-access-key\fP="" + Access key, e.g. user name when credential type is 'basic' + +.PP +\fB--credential-access-secret\fP="" + Access secret, e.g. password when credential type is 'basic' + +.PP +\fB--credential-type\fP="" + Credential type, such as 'basic', 'oauth' + +.PP +\fB--description\fP="" + Description of the registry + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for update + +.PP +\fB--insecure\fP[=true] + Whether or not the certificate will be verified when Harbor tries to access the server + +.PP +\fB--name\fP="" + Name of the registry + +.PP +\fB--type\fP="" + Type of the registry + +.PP +\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) + +.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-registry-view.1 b/doc/man_docs/harbor-registry-view.1 new file mode 100644 index 00000000..ee94b57b --- /dev/null +++ b/doc/man_docs/harbor-registry-view.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-registry-view - get registry by id + + +.SH SYNOPSIS +.PP +\fBharbor registry view [flags]\fP + + +.SH DESCRIPTION +.PP +get registry by 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) + +.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-registry.1 b/doc/man_docs/harbor-registry.1 new file mode 100644 index 00000000..2675b79c --- /dev/null +++ b/doc/man_docs/harbor-registry.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 registry list +.EE + + +.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 diff --git a/doc/man_docs/harbor-repo-delete.1 b/doc/man_docs/harbor-repo-delete.1 new file mode 100644 index 00000000..8ed1eeba --- /dev/null +++ b/doc/man_docs/harbor-repo-delete.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 repository delete [project_name]/[repository_name] +.EE + + +.SH SEE ALSO +.PP +\fBharbor-repo(1)\fP diff --git a/doc/man_docs/harbor-repo-info.1 b/doc/man_docs/harbor-repo-info.1 new file mode 100644 index 00000000..a6dba505 --- /dev/null +++ b/doc/man_docs/harbor-repo-info.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 2024" "Habor Community" "Harbor User Mannuals" + +.SH NAME +.PP +harbor-repo-info - Get repository information + + +.SH SYNOPSIS +.PP +\fBharbor repo info [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 + + +.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 repo info / +.EE + + +.SH SEE ALSO +.PP +\fBharbor-repo(1)\fP diff --git a/doc/man_docs/harbor-repo-list.1 b/doc/man_docs/harbor-repo-list.1 new file mode 100644 index 00000000..c1d12ee3 --- /dev/null +++ b/doc/man_docs/harbor-repo-list.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + + +.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-repo(1)\fP diff --git a/doc/man_docs/harbor-repo.1 b/doc/man_docs/harbor-repo.1 new file mode 100644 index 00000000..6f561d0c --- /dev/null +++ b/doc/man_docs/harbor-repo.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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(1)\fP, \fBharbor-repo-delete(1)\fP, \fBharbor-repo-info(1)\fP, \fBharbor-repo-list(1)\fP diff --git a/doc/man_docs/harbor-user-create.1 b/doc/man_docs/harbor-user-create.1 new file mode 100644 index 00000000..9934fbd7 --- /dev/null +++ b/doc/man_docs/harbor-user-create.1 @@ -0,0 +1,61 @@ +.nh +.TH "HARBOR" "1" "Jul 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 + +.PP +\fB--email\fP="" + Email + +.PP +\fB-h\fP, \fB--help\fP[=false] + help for create + +.PP +\fB--password\fP="" + Password + +.PP +\fB--realname\fP="" + Realname + +.PP +\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) + +.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-user-delete.1 b/doc/man_docs/harbor-user-delete.1 new file mode 100644 index 00000000..372ae297 --- /dev/null +++ b/doc/man_docs/harbor-user-delete.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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-user-elevate.1 b/doc/man_docs/harbor-user-elevate.1 new file mode 100644 index 00000000..3bc57ac4 --- /dev/null +++ b/doc/man_docs/harbor-user-elevate.1 @@ -0,0 +1,41 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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-user-list.1 b/doc/man_docs/harbor-user-list.1 new file mode 100644 index 00000000..e3f4cdaa --- /dev/null +++ b/doc/man_docs/harbor-user-list.1 @@ -0,0 +1,41 @@ +.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-user.1 b/doc/man_docs/harbor-user.1 new file mode 100644 index 00000000..bde84e51 --- /dev/null +++ b/doc/man_docs/harbor-user.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 user list +.EE + + +.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 diff --git a/doc/man_docs/harbor-version.1 b/doc/man_docs/harbor-version.1 new file mode 100644 index 00000000..90d60b02 --- /dev/null +++ b/doc/man_docs/harbor-version.1 @@ -0,0 +1,47 @@ +.nh +.TH "HARBOR" "1" "Jul 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) + +.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 version +.EE + + +.SH SEE ALSO +.PP +\fBharbor(1)\fP diff --git a/doc/man_docs/harbor.1 b/doc/man_docs/harbor.1 new file mode 100644 index 00000000..fa20a67c --- /dev/null +++ b/doc/man_docs/harbor.1 @@ -0,0 +1,51 @@ +.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 diff --git a/doc/md_doc.go b/doc/md_doc.go deleted file mode 100644 index f5e3f6b7..00000000 --- a/doc/md_doc.go +++ /dev/null @@ -1,33 +0,0 @@ -package main - -import ( - "fmt" - "os" - - cmd "github.com/goharbor/harbor-cli/cmd/harbor/root" - "github.com/spf13/cobra/doc" -) - -func main() { - // create temporary dir in currentDir for documents. - // Assuming you are executing from the main directory. - currentDir, err := os.Getwd() - if err != nil { - fmt.Println(err) - } - docDir := fmt.Sprintf("%s/%s", currentDir, "doc/md_docs/") - os.RemoveAll(docDir) - err = os.MkdirAll(docDir, os.ModePerm) - if err != nil { - fmt.Println("Error creating docs directory:", err) - os.Exit(1) - } - - err = doc.GenMarkdownTree(cmd.RootCmd(), docDir) - if err != nil { - fmt.Println("Error generating documentation:", err) - os.Exit(1) - } - - fmt.Println("Documentation generated successfully in", docDir) -} diff --git a/go.mod b/go.mod index e4adb6fb..c26ba590 100644 --- a/go.mod +++ b/go.mod @@ -23,7 +23,6 @@ require ( github.com/charmbracelet/x/windows v0.1.0 // indirect github.com/cpuguy83/go-md2man/v2 v2.0.4 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect - github.com/cpuguy83/go-md2man/v2 v2.0.3 // indirect github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect github.com/fsnotify/fsnotify v1.7.0 // indirect github.com/hashicorp/hcl v1.0.0 // indirect