You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Welcome to the Harbor CLI project! This powerful command-line tool facilitates seamless interaction with the Harbor container registry. It simplifies various tasks such as creating, updating, and managing projects, registries, and other resources in Harbor.**
3
+
**Harbor CLI — a command-line interface for interacting with your Harbor container registry. A streamlined, user-friendly alternative to the WebUI, as your daily driver or for scripting and automation.**
The Harbor CLI is designed to enhance your interaction with the Harbor container registry. Built on Golang, it offers a user-friendly interface to perform various tasks related to projects, registries, and more. Whether you're creating, updating, or managing resources, the Harbor CLI streamlines your workflow efficiently.
10
+
1. CLI alternative to the WebUI
11
+
2. Tool for scripting and automation of common repeatable Harbor tasks running on your machine or inside your pipeline
11
12
12
-
# Project Features 🤯
13
+
# Features
14
+
The project's first goal is to reach WebUI parity.
15
+
16
+
[] project Mange projects
17
+
[] repo Manage repositories
18
+
[] artifact Manage artifacts
19
+
[] label Manage labels
20
+
[] tag Manage tags
21
+
[] quota Manage quotas
22
+
[] webhook Manage webhook policies
23
+
24
+
[] login Log in to Harbor registry
25
+
[] user Manage users
26
+
27
+
[] config Manage the config of the Harbor CLI
28
+
[]cve-allowlist Manage system CVE allowlist
29
+
[] health Get the health status of Harbor components
30
+
[] instance Manage preheat provider instances in Harbor
31
+
[] info Display detailed Harbor system, statistics, and CLI environment information
32
+
33
+
[] registry Manage registries
34
+
[] scanner scanner commands
35
+
[] schedule Schedule jobs in Harbor
36
+
37
+
[] completion Generate the autocompletion script for the specified shell
38
+
[] help Help about any command
39
+
[] version Version of Harbor CLI
13
40
14
-
🔹 Get details about projects, registries, repositories and more <br>
15
-
🔹 Create new projects, registries, and other resources <br>
16
-
🔹 Delete projects, registries, and other resources <br>
17
-
🔹 Run commands with various flags for enhanced functionality <br>
18
-
🔹 More features coming soon... 🚧
19
41
20
42
21
43
# Installation
22
44
23
45
## Container
24
46
25
-
It is straightforward to use the Harbor CLI as a container. You can run the following command to use the Harbor CLI as a container:
47
+
Running Harbor CLI as a container is simple. Use the following command to get started:
26
48
27
49
```shell
28
50
docker run -ti --rm -v $HOME/.config/harbor-cli/config.yaml:/root/.config/harbor-cli/config.yaml \
@@ -32,7 +54,11 @@ docker run -ti --rm -v $HOME/.config/harbor-cli/config.yaml:/root/.config/harbor
32
54
```
33
55
Use the `HARBOR_ENCRYPTION_KEY` container environment variable as a base64-encoded 32-byte key for AES-256 encryption. This securely stores your harbor login password.
34
56
35
-
# Add the following command to create an alias and append the alias to your .zshrc or .bashrc file
57
+
I you intend
58
+
to run the CLI as a container,it is advised
59
+
to set the following environment variables and to create an alias
60
+
and append the alias to your .zshrc or .bashrc file
0 commit comments