Skip to content

Commit

Permalink
Generate usage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec committed Aug 10, 2021
1 parent 0dcf6ae commit 8d42488
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 1 deletion.
2 changes: 1 addition & 1 deletion cmd/cli/docs/capact.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ capact [flags]
* [capact install](capact_install.md) - install Capact into a given environment
* [capact login](capact_login.md) - Login to a Hub (Gateway) server
* [capact logout](capact_logout.md) - Logout from the Hub (Gateway) server
* [capact manifest](capact_manifest.md) - This command consists of multiple subcommands to interact with OCF manifests
* [capact policy](capact_policy.md) - This command consists of multiple subcommands to interact with Policy
* [capact typeinstance](capact_typeinstance.md) - This command consists of multiple subcommands to interact with target TypeInstances
* [capact upgrade](capact_upgrade.md) - Upgrades Capact
* [capact validate](capact_validate.md) - Validate OCF manifests
* [capact version](capact_version.md) - Show version information about this binary

25 changes: 25 additions & 0 deletions cmd/cli/docs/capact_manifest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: capact manifest
---

## capact manifest

This command consists of multiple subcommands to interact with OCF manifests

### Options

```
-h, --help help for manifest
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
```

### SEE ALSO

* [capact](capact.md) - Collective Capability Manager CLI
* [capact manifest validate](capact_manifest_validate.md) - Validate OCF manifests

48 changes: 48 additions & 0 deletions cmd/cli/docs/capact_manifest_validate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: capact manifest validate
---

## capact manifest validate

Validate OCF manifests

```
capact manifest validate [flags]
```

### Examples

```
# Validate interface-group.yaml file with OCF specification in default location
capact manifest validate ocf-spec/0.0.1/examples/interface-group.yaml
# Validate multiple files inside test_manifests directory
capact manifest validate pkg/cli/test_manifests/*.yaml
# Validate interface-group.yaml file with custom OCF specification location
capact manifest validate -s my/ocf/spec/directory ocf-spec/0.0.1/examples/interface-group.yaml
# Validate all Hub manifests
capact manifest validate ./manifests/**/*.yaml
```

### Options

```
--concurrency int Maximum number of concurrent workers. (default 5)
-r, --enable-remote-checks Executes additional manifests checks against Capact Hub.
-h, --help help for validate
-s, --schemas string Path to the local directory with OCF JSONSchemas. If not provided, built-in JSONSchemas are used.
-v, --verbose Prints more verbose output.
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
```

### SEE ALSO

* [capact manifest](capact_manifest.md) - This command consists of multiple subcommands to interact with OCF manifests

0 comments on commit 8d42488

Please sign in to comment.