Skip to content

Commit

Permalink
add cli and man docs
Browse files Browse the repository at this point in the history
Signed-off-by: bupd <bupdprasanth@gmail.com>
  • Loading branch information
bupd committed Dec 28, 2024
1 parent ed0a42e commit 6fde0c0
Show file tree
Hide file tree
Showing 97 changed files with 1,438 additions and 681 deletions.
13 changes: 0 additions & 13 deletions doc/cli-docs/_index.md

This file was deleted.

4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact delete
weight: 35
weight: 85
---
## harbor artifact delete

Expand All @@ -21,7 +21,7 @@ harbor artifact delete [flags]
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
42 changes: 0 additions & 42 deletions doc/cli-docs/harbor-artifact-info.md

This file was deleted.

10 changes: 7 additions & 3 deletions doc/cli-docs/harbor-artifact-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact list
weight: 30
weight: 35
---
## harbor artifact list

Expand All @@ -15,13 +15,17 @@ harbor artifact list [flags]
### Options

```sh
-h, --help help for list
-h, --help help for list
-p, --page int Page number (default 1)
-n, --page-size int Size of per page (default 10)
-q, --query string Query string to query resources
-s, --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")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-scan-start.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact scan start
weight: 45
weight: 50
---
## harbor artifact scan start

Expand Down Expand Up @@ -31,7 +31,7 @@ harbor artifact scan start <project>/<repository>/<reference>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-scan-stop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact scan stop
weight: 50
weight: 90
---
## harbor artifact scan stop

Expand Down Expand Up @@ -31,7 +31,7 @@ harbor artifact scan stop <project>/<repository>/<reference>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-scan.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact scan
weight: 40
weight: 80
---
## harbor artifact scan

Expand All @@ -27,7 +27,7 @@ harbor artifact scan start <project>/<repository>/<reference>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-tags-create.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact tags create
weight: 60
weight: 50
---
## harbor artifact tags create

Expand All @@ -27,7 +27,7 @@ harbor artifact tags create <project>/<repository>/<reference> <tag>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
2 changes: 1 addition & 1 deletion doc/cli-docs/harbor-artifact-tags-delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ harbor artifact tags delete <project>/<repository>/<reference> <tag>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-artifact-tags-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact tags list
weight: 65
weight: 25
---
## harbor artifact tags list

Expand All @@ -27,7 +27,7 @@ harbor artifact tags list <project>/<repository>/<reference>
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
2 changes: 1 addition & 1 deletion doc/cli-docs/harbor-artifact-tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ weight: 55
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
42 changes: 42 additions & 0 deletions doc/cli-docs/harbor-artifact-view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: harbor artifact view
weight: 45
---
## harbor artifact view

### Description

##### Get information of an artifact

### Synopsis

Get information of an artifact

```sh
harbor artifact view [flags]
```

### Examples

```sh
harbor artifact view <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for view
```

### Options inherited from parent commands

```sh
-c, --config string config file (default is $HOME/.config/harbor-cli/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

6 changes: 3 additions & 3 deletions doc/cli-docs/harbor-artifact.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor artifact
weight: 20
weight: 40
---
## harbor artifact

Expand All @@ -27,7 +27,7 @@ Manage artifacts in Harbor Repository
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/home/user/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand All @@ -36,8 +36,8 @@ Manage artifacts in Harbor Repository

* [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
* [harbor artifact view](harbor-artifact-view.md) - Get information of an artifact

4 changes: 2 additions & 2 deletions doc/cli-docs/harbor-health.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: harbor health
weight: 80
weight: 30
---
## harbor health

Expand All @@ -27,7 +27,7 @@ harbor health [flags]
### Options inherited from parent commands

```sh
--config string config file (default is $HOME/.harbor/config.yaml) (default "/Users/vadim/.harbor/config.yaml")
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```
Expand Down
46 changes: 46 additions & 0 deletions doc/cli-docs/harbor-label-create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: harbor label create
weight: 20
---
## harbor label create

### Description

##### create label

### Synopsis

create label in harbor

```sh
harbor label create [flags]
```

### Examples

```sh
harbor label create
```

### Options

```sh
--color string Color of the label.color is in hex value (default "#FFFFFF")
-d, --description string Description of the label
-h, --help help for create
-n, --name string Name of the label
-s, --scope string Scope of the label. eg- g(global), p(specific project) (default "g")
```

### Options inherited from parent commands

```sh
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```

### SEE ALSO

* [harbor label](harbor-label.md) - Manage labels in Harbor

39 changes: 39 additions & 0 deletions doc/cli-docs/harbor-label-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: harbor label delete
weight: 60
---
## harbor label delete

### Description

##### delete label

```sh
harbor label delete [flags]
```

### Examples

```sh
harbor label delete [labelname]
```

### Options

```sh
-h, --help help for delete
-s, --scope string default(global).'p' for project labels.Query scope of the label (default "g")
```

### Options inherited from parent commands

```sh
-c, --config string config file (default is $HOME/.config/harbor-cli/config.yaml)
-o, --output-format string Output format. One of: json|yaml
-v, --verbose verbose output
```

### SEE ALSO

* [harbor label](harbor-label.md) - Manage labels in Harbor

Loading

0 comments on commit 6fde0c0

Please sign in to comment.