Skip to content

Commit

Permalink
chore: add user subcommand doc
Browse files Browse the repository at this point in the history
Signed-off-by: Alan Tang <jmtangcs@gmail.com>

chore: add files header

Signed-off-by: Alan Tang <jmtangcs@gmail.com>

chore: add user subcommand doc

Signed-off-by: Alan Tang <jmtangcs@gmail.com>

chore: add user subcommand doc

Signed-off-by: Alan Tang <jmtangcs@gmail.com>
  • Loading branch information
Standing-Man committed Feb 5, 2025
1 parent 5f043ce commit 3c9231d
Show file tree
Hide file tree
Showing 53 changed files with 1,955 additions and 2 deletions.
32 changes: 32 additions & 0 deletions cli-docs/harbor-artifact-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: harbor artifact delete
weight: 15
---
## 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
-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

36 changes: 36 additions & 0 deletions cli-docs/harbor-artifact-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: harbor artifact list
weight: 80
---
## harbor artifact list

### Description

##### list artifacts within a repository

```sh
harbor artifact list [flags]
```

### Options

```sh
-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
-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

42 changes: 42 additions & 0 deletions cli-docs/harbor-artifact-scan-start.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: harbor artifact scan start
weight: 0
---
## 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 <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for start
```

### 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 scan](harbor-artifact-scan.md) - Scan an artifact

42 changes: 42 additions & 0 deletions cli-docs/harbor-artifact-scan-stop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: harbor artifact scan stop
weight: 85
---
## 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 <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for stop
```

### 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 scan](harbor-artifact-scan.md) - Scan an artifact

40 changes: 40 additions & 0 deletions cli-docs/harbor-artifact-scan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: harbor artifact scan
weight: 85
---
## harbor artifact scan

### Description

##### Scan an artifact

### Synopsis

Scan an artifact in Harbor Repository

### Examples

```sh
harbor artifact scan start <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for scan
```

### 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
* [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

38 changes: 38 additions & 0 deletions cli-docs/harbor-artifact-tags-create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: harbor artifact tags create
weight: 70
---
## harbor artifact tags create

### Description

##### Create a tag of an artifact

```sh
harbor artifact tags create [flags]
```

### Examples

```sh
harbor artifact tags create <project>/<repository>/<reference> <tag>
```

### Options

```sh
-h, --help help for create
```

### 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 tags](harbor-artifact-tags.md) - Manage tags of an artifact

38 changes: 38 additions & 0 deletions cli-docs/harbor-artifact-tags-delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: harbor artifact tags delete
weight: 30
---
## harbor artifact tags delete

### Description

##### Delete a tag of an artifact

```sh
harbor artifact tags delete [flags]
```

### Examples

```sh
harbor artifact tags delete <project>/<repository>/<reference> <tag>
```

### Options

```sh
-h, --help help for delete
```

### 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 tags](harbor-artifact-tags.md) - Manage tags of an artifact

38 changes: 38 additions & 0 deletions cli-docs/harbor-artifact-tags-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: harbor artifact tags list
weight: 85
---
## harbor artifact tags list

### Description

##### List tags of an artifact

```sh
harbor artifact tags list [flags]
```

### Examples

```sh
harbor artifact tags list <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for list
```

### 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 tags](harbor-artifact-tags.md) - Manage tags of an artifact

37 changes: 37 additions & 0 deletions cli-docs/harbor-artifact-tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: harbor artifact tags
weight: 70
---
## harbor artifact tags

### Description

##### Manage tags of an artifact

### Examples

```sh
harbor artifact tags list <project>/<repository>/<reference>
```

### Options

```sh
-h, --help help for tags
```

### 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
* [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

42 changes: 42 additions & 0 deletions 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: 75
---
## 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

Loading

0 comments on commit 3c9231d

Please sign in to comment.