Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Bishal Das  <70086051+bishal7679@users.noreply.github.com>
Signed-off-by: bishal7679 <bishalhnj127@gmail.com>
  • Loading branch information
bishal7679 committed May 20, 2024
1 parent 381ec2d commit a029eb4
Showing 1 changed file with 64 additions and 29 deletions.
93 changes: 64 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,74 @@
# harbor-cli
LFX mentorship program project original author https://github.com/akshatdalton

https://github.com/cncf/mentoring/tree/main/programs/lfx-mentorship/2023/01-Mar-May#an-official-golang-api-client-and-cli-for-harbor
https://mentorship.lfx.linuxfoundation.org/project/7e8cb88a-5b37-471c-8db8-e11907b5a661
![harbor-3](https://github.com/goharbor/harbor-cli/assets/70086051/835ab686-1cce-4ac7-bc57-05a35c2b73cc)

#Under Contstruction!
# How to Install:
**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.**

- Run `go mod download` to install the dependencies
- Run `go build -o harbor` to generate the build file
# Project Scope 🧪

# How to Use:
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.

If you have completed the above steps, now you are all set to use this project.
<br>
<br>
`./harbor --help` or do `./harbor help`:
```shell
Official Harbor CLI
# **Project Features** 🤯

Usage:
harbor [command]
🔹 Get details about projects, registries, repositories and more <br>
🔹 Create new projects, registries, and other resources <br>
🔹 Delete projects, registries, and other resources <br>
🔹 Run commands with various flags for enhanced functionality <br>
🔹 More features coming soon... 🚧

Available Commands:
completion Generate the autocompletion script for the specified shell
create create project, registry, etc.
delete delete project, registry, etc.
get get project, registry, etc.
help Help about any command
list list project, registry, etc.
login Log in to Harbor registry
update update registry, etc.
# Demo Screenshot

Flags:
-h, --help help for harbor
![demo-1](https://github.com/goharbor/harbor-cli/assets/70086051/63b5f6b7-319b-4c05-968a-59489f7fdd35)

Use "harbor [command] --help" for more information about a command.
![demo-2](https://github.com/goharbor/harbor-cli/assets/70086051/00afaa16-41c4-460d-8ec1-7b06b02bd80c)

# Supported Platforms

Platform | Status
--|--
Linux | ✅
macOS | ✅
Windows | ✅

# Installation

## Build From Source
```bash
git clone https://github.com/goharbor/harbor-cli.git
cd harbor-cli/cmd/harbor
go build .
sudo mv harbor /usr/local/bin/
```
## Linux and MacOS
use `amd64/arm64` as per your system architecture
```bash
## Linux
tar -xzf harbor_0.0.1_linux_amd64.tar.gz
cd harbor_0.0.1_linux_amd64
sudo mv harbor /usr/local/bin/

## MacOS
tar -xzf harbor_0.0.1_darwin_amd64.tar.gz
cd harbor_0.0.1_darwin_amd64
sudo mv harbor /usr/local/bin/
```
## Windows
- Download `harbor_0.0.1_windows_amd64.zip` and Extract it.
- To easily use the harbor-cli from the command line, add the directory containing the `harbor.exe` to your system PATH.
- In the Edit Environment Variable window, click on "New" and add the path to the directory where `harbor.exe` is located (e.g., `C:\path\to\harbor_0.0.1_windows_amd64`).

# Community

* **Twitter:** [@project_harbor](https://twitter.com/project_harbor)
* **User Group:** Join Harbor user email group: [harbor-users@lists.cncf.io](https://lists.cncf.io/g/harbor-users) to get update of Harbor's news, features, releases, or to provide suggestion and feedback.
* **Developer Group:** Join Harbor developer group: [harbor-dev@lists.cncf.io](https://lists.cncf.io/g/harbor-dev) for discussion on Harbor development and contribution.
* **Slack:** Join Harbor's community for discussion and ask questions: [Cloud Native Computing Foundation](https://slack.cncf.io/), channel: [#harbor](https://cloud-native.slack.com/messages/harbor/), [#harbor-dev](https://cloud-native.slack.com/messages/harbor-dev/) and [#harbor-cli](https://cloud-native.slack.com/messages/harbor-cli/).

# License
This project is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/goharbor/harbor-cli/blob/main/LICENSE) file for details.

# Acknowledgements
This project is maintained by the Harbor community. We thank all our contributors and users for their support.

# ❤️ Show your support
For any questions or issues, please open an issue on our [GitHub Issues](https://github.com/goharbor/harbor-cli/issues) page.<br>
Give a ⭐ if this project helped you, Thank YOU!

0 comments on commit a029eb4

Please sign in to comment.