Skip to content

Commit d342025

Browse files
cli-docs-botgithub-actions[bot]
authored andcommitted
Update master CLI reference docs for v2.4.0-rc.0.159.ga74fae5
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent b121468 commit d342025

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

content/cli/master/command-reference.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: "Command reference for the Crossplane CLI"
1111
<!-- vale Crossplane.Spelling = NO -->
1212
<!-- vale cli-docs = YES -->
1313

14-
This documentation is for the `crossplane` CLI `v2.4.0-rc.0.126.g62cadf8`.
14+
This documentation is for the `crossplane` CLI `v2.4.0-rc.0.159.ga74fae5`.
1515

1616

1717
<!-- vale Google.Headings = NO -->
@@ -514,8 +514,8 @@ crossplane composition render <composite-resource> <composition> [<functions>] [
514514
| `-r` | `--include-function-results` | Include informational and warning messages from Functions in the rendered output as resources of kind: Result. |
515515
| `-x` | `--include-full-xr` | Include a direct copy of the input XR's spec and metadata fields in the rendered output. |
516516
| `-o` | `--observed-resources=PATH` | A YAML file or directory of YAML files specifying the observed state of composed resources. |
517-
| | `--extra-resources=PATH` | A YAML file or directory of YAML files specifying required resources (deprecated, use --required-resources). |
518-
| `-e` | `--required-resources=PATH` | A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline. |
517+
| | `--extra-resources=PATH` | A YAML file or directory of YAML files specifying required resources (deprecated, use --required-resources). Provide multiple files by repeating the argument. |
518+
| `-e` | `--required-resources=PATH` | A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline. Provide multiple files by repeating the argument. |
519519
| `-s` | `--required-schemas=DIR` | A directory of JSON files specifying OpenAPI v3 schemas (from kubectl get --raw /openapi/v3/<group-version>). |
520520
| `-c` | `--include-context` | Include the context in the rendered output as a resource of kind: Context. |
521521
| | `--function-credentials=PATH` | A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR. |
@@ -1077,7 +1077,7 @@ crossplane operation render <operation> [<functions>] [flags]
10771077
| `-c` | `--include-context` | Include the context in the rendered output as a resource of kind: Context. |
10781078
| `-o` | `--include-full-operation` | Include a direct copy of the input Operation's spec and metadata fields in the rendered output. |
10791079
| `-r` | `--include-function-results` | Include informational and warning messages from functions in the rendered output as resources of kind: Result. |
1080-
| `-e` | `--required-resources=PATH` | A YAML file or directory of YAML files specifying required resources to pass to the function pipeline. |
1080+
| `-e` | `--required-resources=PATH` | A YAML file or directory of YAML files specifying required resources to pass to the function pipeline. Provide multiple files by repeating the argument. |
10811081
| | `--required-schemas=DIR` | A directory of JSON files specifying OpenAPI schemas to pass to the function pipeline. |
10821082
| `-w` | `--watched-resource=PATH` | A YAML file specifying the watched resource for WatchOperation rendering. The resource is also added to required resources. |
10831083
| | `--cache-dir=STRING` | Directory for cached xpkg package contents. |
@@ -1229,7 +1229,9 @@ crossplane project init <name> [flags]
12291229
{{< table "table table-sm table-striped" >}}
12301230
| Short flag | Long flag | Description |
12311231
|------------|-----------|-------------|
1232-
| `-d` | `--directory=STRING` | Directory to initialize. Defaults to project name. |
1232+
| `-d` | `--directory=STRING` | Directory to initialize. Defaults to project name |
1233+
| `-r` | `--registry="example.com/my-org"` | Override the registry in the project file. |
1234+
| | `--repository=STRING` | Override the repository name in the project file. Defaults to the project name. |
12331235
{{< /table >}}
12341236

12351237

@@ -2004,7 +2006,7 @@ crossplane xpkg build [flags]
20042006
| | `--embed-runtime-image=NAME` | An OCI image to embed in the package as its runtime. |
20052007
| | `--embed-runtime-image-tarball=PATH` | An OCI image tarball to embed in the package as its runtime. |
20062008
| `-e` | `--examples-root="./examples"` | A directory of example YAML files to include in the package. |
2007-
| | `--ignore=PATH,...` | comma-separated list of globs specifying files to exclude from the build, relative to --package-root. |
2009+
| | `--ignore=PATH,...` | Comma-separated file paths, specified relative to --package-root, to exclude from the package. Crossplane supports wildcards. You can't exclude directories. |
20082010
| `-o` | `--package-file=PATH` | The file to write the package to. Defaults to a generated filename in --package-root. |
20092011
| `-f` | `--package-root="."` | The directory that contains the package's crossplane.yaml file. |
20102012
{{< /table >}}
@@ -2370,6 +2372,7 @@ crossplane xpkg push <package> [flags]
23702372
{{< table "table table-sm table-striped" >}}
23712373
| Short flag | Long flag | Description |
23722374
|------------|-----------|-------------|
2375+
| `-a` | `--oci-annotation=KEY=VALUE,...` | An OCI manifest annotation to add to the package in key=value format. Repeatable. |
23732376
| | `--insecure-skip-tls-verify` | [INSECURE] Skip verifying TLS certificates. |
23742377
| `-f` | `--package-files=PATH` | A comma-separated list of xpkg files to push. |
23752378
{{< /table >}}

0 commit comments

Comments
 (0)