diff --git a/docs/README.md b/docs/README.md index fbfe39662..778b1f72e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -89,4 +89,14 @@ This section describes how developers can build from Harbor source code, customi - [Registry Landscape](build-customize-contribute/registry-landscape.md) - [E2E Test Scripting Guide](build-customize-contribute/e2e_api_python_based_scripting_guide.md) +## Harbor CLI Documentation + +This section provides detailed documentation for the Harbor CLI, which allows users to interact with the Harbor using command-line commands. + +- [harbor artifact](cli-docs/harbor-artifact.md) +- [harbor project](cli-docs/harbor-project.md) +- [harbor registry](cli-docs/harbor-registry.md) +- [harbor repo](cli-docs/harbor-repo.md) +- [harbor user](cli-docs/harbor-user.md) + See also the list of [Articles from the Harbor Community](https://github.com/goharbor/harbor/blob/master/docs/README.md#articles-from-the-community). diff --git a/docs/_index.md b/docs/_index.md index 80fef6743..87adba20b 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -20,6 +20,10 @@ This section describes how users with the developer, maintainer, and project adm This section describes how developers can build from Harbor source code, customize their deployments, and contribute to the open-source Harbor project. [Read more](build-customize-contribute/_index.md) +## Harbor CLI Documentation + +This section provides detailed documentation for the Harbor CLI, which allows users to interact with the Harbor using command-line commands.[Read more](cli-docs/_index.md) + ## Access the Documentation Source Files The source files for this documentation set are located in the [Harbor repository on Github](https://github.com/goharbor/harbor/tree/release-2.8.0/docs). diff --git a/docs/cli-docs/_index.md b/docs/cli-docs/_index.md new file mode 100644 index 000000000..c4a0cdf99 --- /dev/null +++ b/docs/cli-docs/_index.md @@ -0,0 +1,13 @@ +--- +title: Harbor CLI Documentation +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. + +- `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/docs/cli-docs/harbor-artifact-delete.md b/docs/cli-docs/harbor-artifact-delete.md new file mode 100644 index 000000000..fd4d9ca6a --- /dev/null +++ b/docs/cli-docs/harbor-artifact-delete.md @@ -0,0 +1,32 @@ +--- +title: harbor artifact delete +weight: 35 +--- +## harbor artifact delete + +### Description + +##### delete an artifact + +```sh +harbor artifact delete [flags] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-artifact-info.md b/docs/cli-docs/harbor-artifact-info.md new file mode 100644 index 000000000..55157e9a5 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-info.md @@ -0,0 +1,42 @@ +--- +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/docs/cli-docs/harbor-artifact-list.md b/docs/cli-docs/harbor-artifact-list.md new file mode 100644 index 000000000..dd02b30af --- /dev/null +++ b/docs/cli-docs/harbor-artifact-list.md @@ -0,0 +1,32 @@ +--- +title: harbor artifact list +weight: 30 +--- +## harbor artifact list + +### Description + +##### list artifacts within a repository + +```sh +harbor artifact list [flags] +``` + +### Options + +```sh + -h, --help help for list +``` + +### 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/docs/cli-docs/harbor-artifact-scan-start.md b/docs/cli-docs/harbor-artifact-scan-start.md new file mode 100644 index 000000000..31652afe3 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-scan-start.md @@ -0,0 +1,42 @@ +--- +title: harbor artifact scan start +weight: 45 +--- +## harbor artifact scan start + +### Description + +##### Start a scan of an artifact + +### Synopsis + +Start a scan of an artifact in Harbor Repository + +```sh +harbor artifact scan start [flags] +``` + +### Examples + +```sh +harbor artifact scan start // +``` + +### Options + +```sh + -h, --help help for start +``` + +### 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 scan](harbor-artifact-scan.md) - Scan an artifact + diff --git a/docs/cli-docs/harbor-artifact-scan-stop.md b/docs/cli-docs/harbor-artifact-scan-stop.md new file mode 100644 index 000000000..781c6ad26 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-scan-stop.md @@ -0,0 +1,42 @@ +--- +title: harbor artifact scan stop +weight: 50 +--- +## harbor artifact scan stop + +### Description + +##### Stop a scan of an artifact + +### Synopsis + +Stop a scan of an artifact in Harbor Repository + +```sh +harbor artifact scan stop [flags] +``` + +### Examples + +```sh +harbor artifact scan stop // +``` + +### Options + +```sh + -h, --help help for stop +``` + +### 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 scan](harbor-artifact-scan.md) - Scan an artifact + diff --git a/docs/cli-docs/harbor-artifact-scan.md b/docs/cli-docs/harbor-artifact-scan.md new file mode 100644 index 000000000..c5af733e7 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-scan.md @@ -0,0 +1,40 @@ +--- +title: harbor artifact scan +weight: 40 +--- +## harbor artifact scan + +### Description + +##### Scan an artifact + +### Synopsis + +Scan an artifact in Harbor Repository + +### Examples + +```sh +harbor artifact scan start // +``` + +### Options + +```sh + -h, --help help for scan +``` + +### 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 +* [harbor artifact scan start](harbor-artifact-scan-start.md) - Start a scan of an artifact +* [harbor artifact scan stop](harbor-artifact-scan-stop.md) - Stop a scan of an artifact + diff --git a/docs/cli-docs/harbor-artifact-tags-create.md b/docs/cli-docs/harbor-artifact-tags-create.md new file mode 100644 index 000000000..236c3d82f --- /dev/null +++ b/docs/cli-docs/harbor-artifact-tags-create.md @@ -0,0 +1,38 @@ +--- +title: harbor artifact tags create +weight: 60 +--- +## harbor artifact tags create + +### Description + +##### Create a tag of an artifact + +```sh +harbor artifact tags create [flags] +``` + +### Examples + +```sh +harbor artifact tags create // +``` + +### Options + +```sh + -h, --help help for create +``` + +### 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 tags](harbor-artifact-tags.md) - Manage tags of an artifact + diff --git a/docs/cli-docs/harbor-artifact-tags-delete.md b/docs/cli-docs/harbor-artifact-tags-delete.md new file mode 100644 index 000000000..b5b2e15e1 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-tags-delete.md @@ -0,0 +1,38 @@ +--- +title: harbor artifact tags delete +weight: 70 +--- +## harbor artifact tags delete + +### Description + +##### Delete a tag of an artifact + +```sh +harbor artifact tags delete [flags] +``` + +### Examples + +```sh +harbor artifact tags delete // +``` + +### Options + +```sh + -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") + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor artifact tags](harbor-artifact-tags.md) - Manage tags of an artifact + diff --git a/docs/cli-docs/harbor-artifact-tags-list.md b/docs/cli-docs/harbor-artifact-tags-list.md new file mode 100644 index 000000000..169ec9501 --- /dev/null +++ b/docs/cli-docs/harbor-artifact-tags-list.md @@ -0,0 +1,38 @@ +--- +title: harbor artifact tags list +weight: 65 +--- +## harbor artifact tags list + +### Description + +##### List tags of an artifact + +```sh +harbor artifact tags list [flags] +``` + +### Examples + +```sh +harbor artifact tags list // +``` + +### Options + +```sh + -h, --help help for list +``` + +### 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 tags](harbor-artifact-tags.md) - Manage tags of an artifact + diff --git a/docs/cli-docs/harbor-artifact-tags.md b/docs/cli-docs/harbor-artifact-tags.md new file mode 100644 index 000000000..683dd452b --- /dev/null +++ b/docs/cli-docs/harbor-artifact-tags.md @@ -0,0 +1,37 @@ +--- +title: harbor artifact tags +weight: 55 +--- +## harbor artifact tags + +### Description + +##### Manage tags of an artifact + +### Examples + +```sh + harbor artifact tags list // +``` + +### Options + +```sh + -h, --help help for tags +``` + +### 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 +* [harbor artifact tags create](harbor-artifact-tags-create.md) - Create a tag of an artifact +* [harbor artifact tags delete](harbor-artifact-tags-delete.md) - Delete a tag of an artifact +* [harbor artifact tags list](harbor-artifact-tags-list.md) - List tags of an artifact + diff --git a/docs/cli-docs/harbor-artifact.md b/docs/cli-docs/harbor-artifact.md new file mode 100644 index 000000000..c267dae89 --- /dev/null +++ b/docs/cli-docs/harbor-artifact.md @@ -0,0 +1,43 @@ +--- +title: harbor artifact +weight: 20 +--- +## harbor artifact + +### Description + +##### Manage artifacts + +### Synopsis + +Manage artifacts in Harbor Repository + +### Examples + +```sh + harbor artifact list +``` + +### Options + +```sh + -h, --help help for artifact +``` + +### 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](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 + diff --git a/docs/cli-docs/harbor-login.md b/docs/cli-docs/harbor-login.md new file mode 100644 index 000000000..4e4018298 --- /dev/null +++ b/docs/cli-docs/harbor-login.md @@ -0,0 +1,39 @@ +--- +title: harbor login +weight: 15 +--- +## harbor login + +### Description + +##### Log in to Harbor registry + +### Synopsis + +Authenticate with Harbor Registry. + +```sh +harbor login [server] [flags] +``` + +### Options + +```sh + -h, --help help for login + --name string name for the set of credentials + -p, --password string Password + -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") + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor](harbor.md) - Official Harbor CLI + diff --git a/docs/cli-docs/harbor-project-create.md b/docs/cli-docs/harbor-project-create.md new file mode 100644 index 000000000..fcea0a3c0 --- /dev/null +++ b/docs/cli-docs/harbor-project-create.md @@ -0,0 +1,37 @@ +--- +title: harbor project create +weight: 80 +--- +## harbor project create + +### Description + +##### create project + +```sh +harbor project create [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) + --registry-id string ID of referenced registry when creating the proxy cache project + --storage-limit string Storage quota of the project (default "-1") +``` + +### 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 project](harbor-project.md) - Manage projects and assign resources to them + diff --git a/docs/cli-docs/harbor-project-delete.md b/docs/cli-docs/harbor-project-delete.md new file mode 100644 index 000000000..fffdcf616 --- /dev/null +++ b/docs/cli-docs/harbor-project-delete.md @@ -0,0 +1,32 @@ +--- +title: harbor project delete +weight: 100 +--- +## harbor project delete + +### Description + +##### delete project by name or id + +```sh +harbor project delete [flags] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-project-list.md b/docs/cli-docs/harbor-project-list.md new file mode 100644 index 000000000..41d6ed66a --- /dev/null +++ b/docs/cli-docs/harbor-project-list.md @@ -0,0 +1,38 @@ +--- +title: harbor project list +weight: 85 +--- +## harbor project list + +### Description + +##### list project + +```sh +harbor project list [flags] +``` + +### Options + +```sh + -h, --help help for list + --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 + -q, --query string Query string to query resources + --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") + -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/docs/cli-docs/harbor-project-logs.md b/docs/cli-docs/harbor-project-logs.md new file mode 100644 index 000000000..c4d046ae3 --- /dev/null +++ b/docs/cli-docs/harbor-project-logs.md @@ -0,0 +1,32 @@ +--- +title: harbor project logs +weight: 90 +--- +## harbor project logs + +### Description + +##### get project logs + +```sh +harbor project logs [flags] +``` + +### Options + +```sh + -h, --help help for logs +``` + +### 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 project](harbor-project.md) - Manage projects and assign resources to them + diff --git a/docs/cli-docs/harbor-project-view.md b/docs/cli-docs/harbor-project-view.md new file mode 100644 index 000000000..968c7aba3 --- /dev/null +++ b/docs/cli-docs/harbor-project-view.md @@ -0,0 +1,32 @@ +--- +title: harbor project view +weight: 95 +--- +## harbor project view + +### Description + +##### get project by name or id + +```sh +harbor project view [NAME|ID] [flags] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-project.md b/docs/cli-docs/harbor-project.md new file mode 100644 index 000000000..d18b6b554 --- /dev/null +++ b/docs/cli-docs/harbor-project.md @@ -0,0 +1,43 @@ +--- +title: harbor project +weight: 75 +--- +## harbor project + +### Description + +##### Manage projects and assign resources to them + +### Synopsis + +Manage projects in Harbor + +### Examples + +```sh + harbor project list +``` + +### Options + +```sh + -h, --help help for project +``` + +### 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](harbor.md) - Official Harbor CLI +* [harbor project create](harbor-project-create.md) - create project +* [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 view](harbor-project-view.md) - get project by name or id + diff --git a/docs/cli-docs/harbor-registry-create.md b/docs/cli-docs/harbor-registry-create.md new file mode 100644 index 000000000..99c6f31e5 --- /dev/null +++ b/docs/cli-docs/harbor-registry-create.md @@ -0,0 +1,40 @@ +--- +title: harbor registry create +weight: 110 +--- +## harbor registry create + +### Description + +##### create registry + +```sh +harbor registry create [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' + --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) + --name string Name of the registry + --type string Type of the registry (default "harbor") + --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") + -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/docs/cli-docs/harbor-registry-delete.md b/docs/cli-docs/harbor-registry-delete.md new file mode 100644 index 000000000..f0e1b0ee4 --- /dev/null +++ b/docs/cli-docs/harbor-registry-delete.md @@ -0,0 +1,32 @@ +--- +title: harbor registry delete +weight: 140 +--- +## harbor registry delete + +### Description + +##### delete registry by id + +```sh +harbor registry delete [flags] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-registry-info.md b/docs/cli-docs/harbor-registry-info.md new file mode 100644 index 000000000..2fd7fc45d --- /dev/null +++ b/docs/cli-docs/harbor-registry-info.md @@ -0,0 +1,32 @@ +--- +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/docs/cli-docs/harbor-registry-list.md b/docs/cli-docs/harbor-registry-list.md new file mode 100644 index 000000000..2a230059a --- /dev/null +++ b/docs/cli-docs/harbor-registry-list.md @@ -0,0 +1,36 @@ +--- +title: harbor registry list +weight: 115 +--- +## harbor registry list + +### Description + +##### list registry + +```sh +harbor registry list [flags] +``` + +### Options + +```sh + -h, --help help for list + --page int Page number (default 1) + --page-size int Size of per page (default 10) + -q, --query string Query string to query resources + --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") + -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/docs/cli-docs/harbor-registry-update.md b/docs/cli-docs/harbor-registry-update.md new file mode 100644 index 000000000..7c4a43022 --- /dev/null +++ b/docs/cli-docs/harbor-registry-update.md @@ -0,0 +1,40 @@ +--- +title: harbor registry update +weight: 125 +--- +## harbor registry update + +### Description + +##### update registry + +```sh +harbor registry update [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' + --credential-type string Credential type, such as 'basic', 'oauth' + --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 +``` + +### 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/docs/cli-docs/harbor-registry-view.md b/docs/cli-docs/harbor-registry-view.md new file mode 100644 index 000000000..62451e95c --- /dev/null +++ b/docs/cli-docs/harbor-registry-view.md @@ -0,0 +1,32 @@ +--- +title: harbor registry view +weight: 130 +--- +## harbor registry view + +### Description + +##### get registry by id + +```sh +harbor registry view [flags] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-registry.md b/docs/cli-docs/harbor-registry.md new file mode 100644 index 000000000..ce862d95d --- /dev/null +++ b/docs/cli-docs/harbor-registry.md @@ -0,0 +1,44 @@ +--- +title: harbor registry +weight: 105 +--- +## harbor registry + +### Description + +##### Manage registries + +### Synopsis + +Manage registries in Harbor + +### Examples + +```sh + harbor registry list +``` + +### Options + +```sh + -h, --help help for registry +``` + +### 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](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 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 + diff --git a/docs/cli-docs/harbor-repo-delete.md b/docs/cli-docs/harbor-repo-delete.md new file mode 100644 index 000000000..36e3bc342 --- /dev/null +++ b/docs/cli-docs/harbor-repo-delete.md @@ -0,0 +1,42 @@ +--- +title: harbor repo delete +weight: 160 +--- +## harbor repo delete + +### Description + +##### Delete a repository + +### Synopsis + +Delete a repository within a project in Harbor + +```sh +harbor repo delete [flags] +``` + +### Examples + +```sh + harbor repository delete [project_name]/[repository_name] +``` + +### Options + +```sh + -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") + -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/docs/cli-docs/harbor-repo-info.md b/docs/cli-docs/harbor-repo-info.md new file mode 100644 index 000000000..e1aaaeaf6 --- /dev/null +++ b/docs/cli-docs/harbor-repo-info.md @@ -0,0 +1,42 @@ +--- +title: harbor repo info +weight: 155 +--- +## harbor repo info + +### Description + +##### Get repository information + +### Synopsis + +Get information of a particular repository in a project + +```sh +harbor repo info [flags] +``` + +### Examples + +```sh + harbor repo 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 repo](harbor-repo.md) - Manage repositories + diff --git a/docs/cli-docs/harbor-repo-list.md b/docs/cli-docs/harbor-repo-list.md new file mode 100644 index 000000000..5274a5429 --- /dev/null +++ b/docs/cli-docs/harbor-repo-list.md @@ -0,0 +1,32 @@ +--- +title: harbor repo list +weight: 150 +--- +## harbor repo list + +### Description + +##### list repositories within a project + +```sh +harbor repo list [flags] +``` + +### Options + +```sh + -h, --help help for list +``` + +### 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 repo](harbor-repo.md) - Manage repositories + diff --git a/docs/cli-docs/harbor-repo.md b/docs/cli-docs/harbor-repo.md new file mode 100644 index 000000000..6a3538e7b --- /dev/null +++ b/docs/cli-docs/harbor-repo.md @@ -0,0 +1,35 @@ +--- +title: harbor repo +weight: 145 +--- +## harbor repo + +### Description + +##### Manage repositories + +### Synopsis + +Manage repositories in Harbor context + +### Options + +```sh + -h, --help help for repo +``` + +### 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](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 + diff --git a/docs/cli-docs/harbor-user-create.md b/docs/cli-docs/harbor-user-create.md new file mode 100644 index 000000000..8337ac0a0 --- /dev/null +++ b/docs/cli-docs/harbor-user-create.md @@ -0,0 +1,37 @@ +--- +title: harbor user create +weight: 170 +--- +## harbor user create + +### Description + +##### create user + +```sh +harbor user create [flags] +``` + +### Options + +```sh + --comment string Comment + --email string Email + -h, --help help for create + --password string Password + --realname string Realname + --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") + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor user](harbor-user.md) - Manage users + diff --git a/docs/cli-docs/harbor-user-delete.md b/docs/cli-docs/harbor-user-delete.md new file mode 100644 index 000000000..f443621fe --- /dev/null +++ b/docs/cli-docs/harbor-user-delete.md @@ -0,0 +1,32 @@ +--- +title: harbor user delete +weight: 185 +--- +## harbor user delete + +### Description + +##### delete user + +```sh +harbor user delete [flags] +``` + +### Options + +```sh + -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") + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor user](harbor-user.md) - Manage users + diff --git a/docs/cli-docs/harbor-user-elevate.md b/docs/cli-docs/harbor-user-elevate.md new file mode 100644 index 000000000..42011e8fb --- /dev/null +++ b/docs/cli-docs/harbor-user-elevate.md @@ -0,0 +1,36 @@ +--- +title: harbor user elevate +weight: 180 +--- +## harbor user elevate + +### Description + +##### elevate user + +### Synopsis + +elevate user to admin role + +```sh +harbor user elevate [flags] +``` + +### Options + +```sh + -h, --help help for elevate +``` + +### 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 user](harbor-user.md) - Manage users + diff --git a/docs/cli-docs/harbor-user-list.md b/docs/cli-docs/harbor-user-list.md new file mode 100644 index 000000000..fed5f4641 --- /dev/null +++ b/docs/cli-docs/harbor-user-list.md @@ -0,0 +1,32 @@ +--- +title: harbor user list +weight: 175 +--- +## harbor user list + +### Description + +##### list users + +```sh +harbor user list [flags] +``` + +### Options + +```sh + -h, --help help for list +``` + +### 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 user](harbor-user.md) - Manage users + diff --git a/docs/cli-docs/harbor-user.md b/docs/cli-docs/harbor-user.md new file mode 100644 index 000000000..f41bb4809 --- /dev/null +++ b/docs/cli-docs/harbor-user.md @@ -0,0 +1,42 @@ +--- +title: harbor user +weight: 165 +--- +## harbor user + +### Description + +##### Manage users + +### Synopsis + +Manage users in Harbor + +### Examples + +```sh + harbor user list +``` + +### Options + +```sh + -h, --help help for user +``` + +### 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](harbor.md) - Official Harbor CLI +* [harbor user create](harbor-user-create.md) - create user +* [harbor user delete](harbor-user-delete.md) - delete user +* [harbor user elevate](harbor-user-elevate.md) - elevate user +* [harbor user list](harbor-user-list.md) - list users + diff --git a/docs/cli-docs/harbor-version.md b/docs/cli-docs/harbor-version.md new file mode 100644 index 000000000..e7fc4cc97 --- /dev/null +++ b/docs/cli-docs/harbor-version.md @@ -0,0 +1,42 @@ +--- +title: harbor version +weight: 10 +--- +## harbor version + +### Description + +##### Version of Harbor CLI + +### Synopsis + +Get Harbor CLI version, git commit, go version, build time, release channel, os/arch, etc. + +```sh +harbor version [flags] +``` + +### Examples + +```sh + harbor version +``` + +### Options + +```sh + -h, --help help for version +``` + +### 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](harbor.md) - Official Harbor CLI + diff --git a/docs/cli-docs/harbor.md b/docs/cli-docs/harbor.md new file mode 100644 index 000000000..5b7f98e8d --- /dev/null +++ b/docs/cli-docs/harbor.md @@ -0,0 +1,45 @@ +--- +title: harbor +weight: 5 +--- +## harbor + +### Description + +##### Official Harbor CLI + +### Synopsis + +Official Harbor CLI + +### Examples + +```sh + +// Base command: +harbor + +// Display help about the command: +harbor help + +``` + +### Options + +```sh + --config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml") + -h, --help help for harbor + -o, --output-format string Output format. One of: json|yaml + -v, --verbose verbose output +``` + +### SEE ALSO + +* [harbor artifact](harbor-artifact.md) - Manage artifacts +* [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 user](harbor-user.md) - Manage users +* [harbor version](harbor-version.md) - Version of Harbor CLI +