Skip to content

Commit

Permalink
make docs and schema
Browse files Browse the repository at this point in the history
Signed-off-by: Austin Abro <[email protected]>
  • Loading branch information
AustinAbro321 committed Jan 17, 2025
1 parent d024ec8 commit 9e9777b
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 2 deletions.
1 change: 1 addition & 0 deletions site/src/content/docs/commands/zarf_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Commands useful for developing packages
* [zarf dev find-images](/commands/zarf_dev_find-images/) - Evaluates components in a Zarf file to identify images specified in their helm charts and manifests
* [zarf dev generate](/commands/zarf_dev_generate/) - [alpha] Creates a zarf.yaml automatically from a given remote (git) Helm chart
* [zarf dev generate-config](/commands/zarf_dev_generate-config/) - Generates a config file for Zarf
* [zarf dev inspect](/commands/zarf_dev_inspect/) - Commands to get information about a Zarf package using a `zarf.yaml`
* [zarf dev lint](/commands/zarf_dev_lint/) - Lints the given package for valid schema and recommended practices
* [zarf dev patch-git](/commands/zarf_dev_patch-git/) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE. NOTE:
This should only be used for manifests that are not mutated by the Zarf Agent Mutating Webhook.
Expand Down
38 changes: 38 additions & 0 deletions site/src/content/docs/commands/zarf_dev_inspect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: zarf dev inspect
description: Zarf CLI command reference for <code>zarf dev inspect</code>.
tableOfContents: false
---

<!-- Page generated by Zarf; DO NOT EDIT -->

## zarf dev inspect

Commands to get information about a Zarf package using a `zarf.yaml`

### Options

```
-h, --help help for inspect
```

### Options inherited from parent commands

```
-a, --architecture string Architecture for OCI images and Zarf packages
--insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture.
--log-format string [beta] Select a logging format. Defaults to 'console'. Valid options are: 'console', 'json', 'dev'
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture.
--tmpdir string Specify the temporary directory to use for intermediate files
--zarf-cache string Specify the location of the Zarf cache directory (default "~/.zarf-cache")
```

### SEE ALSO

* [zarf dev](/commands/zarf_dev/) - Commands useful for developing packages
* [zarf dev inspect definition](/commands/zarf_dev_inspect_definition/) - Displays the fully rendered package definition

47 changes: 47 additions & 0 deletions site/src/content/docs/commands/zarf_dev_inspect_definition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: zarf dev inspect definition
description: Zarf CLI command reference for <code>zarf dev inspect definition</code>.
tableOfContents: false
---

<!-- Page generated by Zarf; DO NOT EDIT -->

## zarf dev inspect definition

Displays the fully rendered package definition

### Synopsis

Displays the 'zarf.yaml' definition of a Zarf after package templating, flavors, and component imports are applied

```
zarf dev inspect definition [ DIRECTORY ] [flags]
```

### Options

```
-f, --flavor string The flavor of components to include in the resulting package (i.e. have a matching or empty "only.flavor" key)
-h, --help help for definition
--set stringToString Specify package variables to set on the command line (KEY=value) (default [])
```

### Options inherited from parent commands

```
-a, --architecture string Architecture for OCI images and Zarf packages
--insecure-skip-tls-verify Skip checking server's certificate for validity. This flag should only be used if you have a specific reason and accept the reduced security posture.
--log-format string [beta] Select a logging format. Defaults to 'console'. Valid options are: 'console', 'json', 'dev'
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-color Disable colors in output
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--plain-http Force the connections over HTTP instead of HTTPS. This flag should only be used if you have a specific reason and accept the reduced security posture.
--tmpdir string Specify the temporary directory to use for intermediate files
--zarf-cache string Specify the location of the Zarf cache directory (default "~/.zarf-cache")
```

### SEE ALSO

* [zarf dev inspect](/commands/zarf_dev_inspect/) - Commands to get information about a Zarf package using a `zarf.yaml`

4 changes: 2 additions & 2 deletions src/cmd/dev.go
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ func NewDevCommand() *cobra.Command {
func NewDevInspectCommand(v *viper.Viper) *cobra.Command {
cmd := &cobra.Command{
Use: "inspect",
Short: "Inspect a zarf package ",
Short: "Commands to get information about a Zarf package using a `zarf.yaml`",
}

cmd.AddCommand(NewDevInspectDefinitionCommand(v))
Expand All @@ -81,7 +81,7 @@ func NewDevInspectDefinitionCommand(v *viper.Viper) *cobra.Command {
cmd := &cobra.Command{
Use: "definition [ DIRECTORY ]",
Args: cobra.MaximumNArgs(1),
Short: "Displays the definition of a Zarf package",
Short: "Displays the fully rendered package definition",
Long: "Displays the 'zarf.yaml' definition of a Zarf after package templating, flavors, and component imports are applied",
RunE: o.Run,
}
Expand Down

0 comments on commit 9e9777b

Please sign in to comment.