Skip to content

Commit

Permalink
README: Add instructions on how to install and use.
Browse files Browse the repository at this point in the history
Signed-off-by: Akshat <akshat25iiit@gmail.com>
  • Loading branch information
akshatdalton committed Jul 15, 2023
1 parent 48d40bc commit a578d86
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@

# Go workspace file
go.work

# harbor compiled file
harbor
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,35 @@
# harbor-cli
Official Harbor CLI

# How to Install:

- Run `go mod download` to install the dependencies
- Run `go build -o harbor` to generate the build file

# How to Use:

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

Usage:
harbor [command]

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.

Flags:
-h, --help help for harbor

Use "harbor [command] --help" for more information about a command.
```

0 comments on commit a578d86

Please sign in to comment.