Skip to content

Commit

Permalink
Merge pull request #1610 from carolynvs/sync-docs
Browse files Browse the repository at this point in the history
Sync cli command documentation
  • Loading branch information
carolynvs authored Jun 3, 2021
2 parents fea7bb9 + 6067f9e commit 669d163
Show file tree
Hide file tree
Showing 68 changed files with 206 additions and 137 deletions.
2 changes: 1 addition & 1 deletion cmd/porter/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ func buildRootCommandFrom(p *porter.Porter) *cobra.Command {
globalFlags := cmd.PersistentFlags()
globalFlags.BoolVar(&p.Debug, "debug", false, "Enable debug logging")
globalFlags.BoolVar(&p.DebugPlugins, "debug-plugins", false, "Enable plugin debug logging")
globalFlags.StringSliceVar(&p.Data.ExperimentalFlags, "experimental", nil, "Comma separated list of experimental features to enable. See https://porter.sh/experimental for available feature flags.")
globalFlags.StringSliceVar(&p.Data.ExperimentalFlags, "experimental", nil, "Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.")

// Flags for just the porter command only, does not apply to sub-commands
cmd.Flags().BoolVarP(&printVersion, "version", "v", false, "Print the application version")
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ porter archive FILENAME --reference PUBLISHED_BUNDLE [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
6 changes: 4 additions & 2 deletions docs/content/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ porter build [flags]

```
-d, --dir string Path to the build context directory where all bundle assets are located.
--driver string Experimental. Driver for building the invocation image. Allowed values are: docker, buildkit (default "docker")
-f, --file porter.yaml Path to the Porter manifest. Defaults to porter.yaml in the current directory.
-h, --help help for build
--name string Override the bundle name
Expand All @@ -41,8 +42,9 @@ porter build [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Commands for working with bundles. These all have shortcuts so that you can call
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ porter bundles archive FILENAME --reference PUBLISHED_BUNDLE [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
6 changes: 4 additions & 2 deletions docs/content/cli/bundles_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ porter bundles build [flags]

```
-d, --dir string Path to the build context directory where all bundle assets are located.
--driver string Experimental. Driver for building the invocation image. Allowed values are: docker, buildkit (default "docker")
-f, --file porter.yaml Path to the Porter manifest. Defaults to porter.yaml in the current directory.
-h, --help help for build
--name string Override the bundle name
Expand All @@ -41,8 +42,9 @@ porter bundles build [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ porter bundles copy [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ porter bundles create [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ porter bundles explain [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ porter bundles inspect [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ porter bundles install [INSTALLATION] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,9 @@ porter bundles invoke [INSTALLATION] --action ACTION [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ porter bundles lint [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ porter bundles uninstall [INSTALLATION] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/bundles_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ porter bundles upgrade [INSTALLATION] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ porter copy [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ porter create [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Credentials commands
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ porter credentials delete NAME [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials_edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ porter credentials edit [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials_generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,9 @@ porter credentials generate [NAME] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ porter credentials list [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/credentials_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ porter credentials show [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ porter explain [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ porter inspect [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ porter install [INSTALLATION] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Commands for working with installations of a bundle
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,9 @@ porter installations delete [INSTALLATION] [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,9 @@ porter installations list [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Commands for working with installation logs
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations_logs_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ porter installations logs show [flags]
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
5 changes: 3 additions & 2 deletions docs/content/cli/installations_output.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Output commands
### Options inherited from parent commands

```
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--debug Enable debug logging
--debug-plugins Enable plugin debug logging
--experimental strings Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.
```

### SEE ALSO
Expand Down
Loading

0 comments on commit 669d163

Please sign in to comment.