Skip to content

Improve generation of reference docs #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adamwg wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve generation of reference docs #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ee9ca8
generate-docs: Clean up maturity level notes
adamwg May 22, 2026
890c04b
Fix vale errors in help
adamwg May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions cmd/crossplane/composition/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ const (
)

type generateCmd struct {
XRD string `arg:"" help:"Path to the CompositeResourceDefinition (XRD) file."`
Name string `help:"Name prefix for the composition." optional:""`
Plural string `help:"Custom plural for the CompositeTypeRef.Kind." optional:""`
Path string `help:"Output file path override." optional:""`
ProjectFile string `default:"crossplane-project.yaml" help:"Path to project definition file." short:"f"`
CacheDir string `env:"CROSSPLANE_XPKG_CACHE" help:"Directory for cached xpkg package contents." name:"cache-dir"`
XRD string `arg:"" help:"Path to the CompositeResourceDefinition (XRD) file."`
Name string `help:"Name prefix for the composition." optional:""`
Plural string `help:"Custom plural for the referenced kind." optional:""`
Path string `help:"Output file." optional:""`
ProjectFile string `default:"crossplane-project.yaml" help:"Path to project definition file." short:"f"`
CacheDir string `env:"CROSSPLANE_XPKG_CACHE" help:"Directory for cached xpkg package contents." name:"cache-dir"`

projFS afero.Fs
apisFS afero.Fs
Expand Down
6 changes: 3 additions & 3 deletions cmd/crossplane/composition/help/generate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
The `composition generate` command creates a Composition for a
CompositeResourceDefinition (XRD). The Composition is scaffolded with a single
CompositeResourceDefinition (XRD). The generated Composition contains a single
pipeline step that runs `function-auto-ready`, which is automatically added to
the project's dependencies if it isn't already present.

Expand All @@ -19,13 +19,13 @@ crossplane composition generate examples/network/network-aws.yaml --name aws
```

Generate a Composition with a custom plural form, useful when automatic
pluralization is wrong (e.g., "postgres"):
pluralization is wrong (for example, "postgres"):

```shell
crossplane composition generate examples/database/database.yaml --plural postgreses
```

Write the generated Composition to a specific path within the project:
Write the generated Composition to a specific path:

```shell
crossplane composition generate apis/network/definition.yaml --path apis/network/composition.yaml
Expand Down
4 changes: 2 additions & 2 deletions cmd/crossplane/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ type ConfigPath string //nolint:revive // The "Config" stutter is intentional; t
// Cmd groups subcommands for inspecting and modifying the CLI config file.
type Cmd struct {
// Keep subcommands sorted alphabetically.
Set setCmd `cmd:"" help:"Set a config value and write it to the config file."`
View viewCmd `cmd:"" help:"Print the current effective config as YAML."`
Set setCmd `cmd:"" help:"Set a value and write it to the configuration file."`
View viewCmd `cmd:"" help:"Print the current effective configuration as YAML."`
}

// Help returns the extended help for the config command.
Expand Down
4 changes: 2 additions & 2 deletions cmd/crossplane/config/help/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
The `config` command manages the configuration file for the `crossplane`
CLI. The config file location is, in priority order:
CLI. The configuration file location is, in priority order:

1. The `--config` flag.
2. The `CROSSPLANE_CONFIG` environment variable.
3. `$XDG_CONFIG_HOME/crossplane/config.yaml` (or `~/.config/crossplane/config.yaml`).

## Examples

Show the current effective config:
Show the current effective configuration:

```shell
crossplane config view
Expand Down
2 changes: 1 addition & 1 deletion cmd/crossplane/config/set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
)

type setCmd struct {
Key string `arg:"" help:"Config key to set (e.g. features.enableAlpha)."`
Key string `arg:"" help:"Key to set (for example, features.enableAlpha)."`
Value string `arg:"" help:"Value to assign."`

fs afero.Fs
Expand Down
6 changes: 3 additions & 3 deletions cmd/crossplane/convert/compositionenvironment/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ var helpDetail string
// Cmd arguments and flags for converting a Composition to use function-environment-configs.
type Cmd struct {
// Arguments.
InputFile string `arg:"" default:"-" help:"The Composition file to be converted. If not specified or '-', stdin will be used." optional:"" predictor:"file" type:"path"`
InputFile string `arg:"" default:"-" help:"The Composition file to convert or '-' for stdin." optional:"" predictor:"file" type:"path"`

// Flags.
OutputFile string `help:"The file to write the generated Composition to. If not specified, stdout will be used." placeholder:"PATH" predictor:"file" short:"o" type:"path"`
OutputFile string `help:"The file to write the generated Composition to; omit for stdout." placeholder:"PATH" predictor:"file" short:"o" type:"path"`

FunctionEnvironmentConfigRef string `default:"function-environment-configs" help:"Name of the existing function-environment-configs Function, to be used to reference it." name:"function-environment-configs-ref"`
FunctionEnvironmentConfigRef string `default:"function-environment-configs" help:"Name of the installed function-environment-configs Function." name:"function-environment-configs-ref"`

fs afero.Fs
}
Expand Down
6 changes: 3 additions & 3 deletions cmd/crossplane/convert/compositionenvironment/help/composition-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
The `composition convert composition-environment` command converts a Crossplane
Composition to use `function-environment-configs` in place of native Composition
Environments, which were removed in Crossplane v1.18.
Environments (removed in Crossplane 1.18).

It adds a function pipeline step using
`crossplane-contrib/function-environment-configs` if needed. By default the
function is referenced as `function-environment-configs`, but this can be
overridden with `--function-environment-configs-ref`.
function name is `function-environment-configs`, but this can be overridden with
`--function-environment-configs-ref`.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion cmd/crossplane/convert/help/convert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The `composition convert` command converts a Crossplane composition to use a
different version or migrate away from features that are no longer supported.

The currently supported conversions are:
The supported conversions are:

- Native Composition Environment → `function-environment-configs`
8 changes: 4 additions & 4 deletions cmd/crossplane/dependency/add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ var addHelp string

// addCmd adds a dependency to the current project.
type addCmd struct {
Package string `arg:"" help:"Package to be added (e.g. xpkg.crossplane.io/crossplane-contrib/provider-nop:v0.5.0, k8s:v1.33.0, a git repo URL, or an HTTP URL)."`
ProjectFile string `default:"crossplane-project.yaml" help:"Path to project definition file." short:"f"`
CacheDir string `env:"CROSSPLANE_XPKG_CACHE" help:"Directory for cached xpkg package contents." name:"cache-dir"`
Package string `arg:"" help:"Package to add (xpkg OCI reference, k8s:<version>, git repository URL, or HTTP(S) URL)."`
ProjectFile string `default:"crossplane-project.yaml" help:"Path to project definition file." short:"f"`
CacheDir string `env:"CROSSPLANE_XPKG_CACHE" help:"Directory for cached xpkg package contents." name:"cache-dir"`

// Flags for specific dependency types.
APIOnly bool `help:"Mark an xpkg dependency as API-only (not a runtime dependency)." name:"api-only"`
GitRef string `help:"Git ref for CRD dependencies (branch, tag, or commit SHA)." name:"git-ref"`
GitPath string `help:"Path within the git repository for CRD dependencies." name:"git-path"`
GitPath string `help:"Path to CRDs in the git repository." name:"git-path"`
}

func (c *addCmd) Help() string {
Expand Down
13 changes: 6 additions & 7 deletions cmd/crossplane/dependency/help/add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The `dependency add` command adds a dependency to a Crossplane Project. The
dependency is added to the project's metadata file and language bindings
(schemas) are generated its CRDs when applicable.
The `dependency add` command adds a dependency to a Crossplane Project metadata
file and generates language bindings (schemas) for the dependency package's
CRDs.

## Dependency types

Expand All @@ -13,10 +13,9 @@ Projects support three kinds of dependencies:
An xpkg dependency may be either a runtime dependency (the default) or a
build-time dependency. Runtime dependencies become dependencies of the
Configuration produced by `crossplane project build` or `crossplane project run`
and thus get installed into a cluster when the Configuration is
installed. Build-time dependencies, on the other hand, are used only for schema
generation and do not become Configuration dependencies. Use the `--api-only`
flag to indicate that an xpkg dependency should be build-time only.
and are thus installed into a cluster with the Configuration. Build-time
dependencies have schemas generated but don't become Configuration
dependencies. Use the `--api-only` flag to add a build-time xpkg dependency.

Non-xpkg dependencies are always build-time dependencies.

Expand Down
8 changes: 3 additions & 5 deletions cmd/crossplane/dependency/help/update-cache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
The `dependency update-cache` command updates the local dependency cache for the
current project. It caches all dependencies listed in the
`crossplane-project.yaml` file and re-generates language bindings (schemas) for
them if needed. Any dependency whose version is expressed as a semantic version
constraint will have the constraint re-resolved to a specific version (i.e.,
schemas will be updated if a newer version is available).
current project. It re-resolves semantic version constraints to specific
versions (fetching newer versions if available), caches all dependencies, and
re-generates language bindings (schemas) for them if needed.
8 changes: 8 additions & 0 deletions cmd/crossplane/docs-templates/command-reference.md.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ description: "Command reference for the Crossplane CLI"

<!-- This file is generated by `crossplane generate-docs`. Do not edit by hand. -->

<!-- We have a special spelling checker for the CLI docs that allows lower-case
"crossplane", since it's the name of the command and we use it everywhere. -->
<!-- vale Crossplane.Spelling = NO -->
<!-- vale cli-docs = YES -->

This documentation is for the `crossplane` CLI [[ .Version ]].

[[ range .Commands ]]
Expand Down Expand Up @@ -43,3 +48,6 @@ crossplane [[ .Summary ]]
[[ end ]]{{< /table >}}
[[ end ]]
[[ end ]]

<!-- vale cli-docs = NO -->
<!-- vale Crossplane.Spelling = YES -->
12 changes: 12 additions & 0 deletions cmd/crossplane/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,13 @@ func normalizeDetail(detail string, headingLevel int) string {
bqRE := regexp.MustCompile(`^> \*\*(\w+):\*\* `)
bqMatch := bqRE.FindStringSubmatch(line)
if bqMatch != nil {
// Omit the feature enablement message from the top-level command
// detail, since it's not useful in the generated docs. It's a
// little gross that we're hard-coding this, but it's good enough.
if strings.Contains(line, "Alpha and beta features are enabled.") {
continue
}

bq = true
fmt.Fprintf(&sb, "{{<hint \"%s\" >}}\n", strings.ToLower(bqMatch[1]))
line = strings.TrimPrefix(line, bqMatch[0])
Expand Down Expand Up @@ -227,6 +234,11 @@ func normalizeDetail(detail string, headingLevel int) string {
sb.WriteString(line + "\n")
}

// Close the "hint" box if it appeared at the very end of the detail.
if bq {
sb.WriteString("{{< /hint >}}\n")
}

return strings.TrimSpace(sb.String())
Comment on lines +237 to 242
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Close table shortcode when detail ends with a table

Nice catch adding the EOF hint close. Could we also close the table shortcode at EOF?
Right now, if the last content line is a table row, the {{< /table >}} close tag is never emitted.

Proposed fix 
 	// Close the "hint" box if it appeared at the very end of the detail.
 	if bq {
 		sb.WriteString("{{< /hint >}}\n")
 	}
+	// Close the table shortcode if detail ended with a table.
+	if table {
+		sb.WriteString("{{< /table >}}\n")
+	}
 
 	return strings.TrimSpace(sb.String())
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
// Close the "hint" box if it appeared at the very end of the detail.
if bq {
sb.WriteString("{{< /hint >}}\n")
}
return strings.TrimSpace(sb.String())
// Close the "hint" box if it appeared at the very end of the detail.
if bq {
sb.WriteString("{{< /hint >}}\n")
}
// Close the table shortcode if detail ended with a table.
if table {
sb.WriteString("{{< /table >}}\n")
}
return strings.TrimSpace(sb.String())
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/docs.go` around lines 237 - 242, The code currently closes the
"hint" shortcode at EOF using the bq flag but forgets to close an open table
shortcode; update the EOF handling in the same function that builds sb (where bq
is used) to also check the table-open flag (e.g., bt) and, if true, append the
table close token "{{< /table >}}\n" to sb before returning
strings.TrimSpace(sb.String()), so any trailing table row is properly
terminated.

}

Expand Down
6 changes: 3 additions & 3 deletions cmd/crossplane/function/help/generate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The `function generate` command creates an embedded function in the specified
language under the project's `functions/` directory. If a path to a Composition
file is supplied, the new function is also idempotently added as a step to the
end of the Composition's pipeline.
language under the project's `functions/` directory. It optionally idempotently
adds the new function to end of a Composition's pipeline when given a
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add missing article for grammatical correctness.

Line 3 should read "to the end of a Composition's pipeline" rather than "to end of a Composition's pipeline."

✏️ Suggested fix 
-adds the new function to end of a Composition's pipeline when given a
+adds the new function to the end of a Composition's pipeline when given a
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
adds the new function to end of a Composition's pipeline when given a
adds the new function to the end of a Composition's pipeline when given a
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/function/help/generate.md` at line 3, Edit the sentence "adds
the new function to end of a Composition's pipeline when given a" to insert the
missing article so it reads "adds the new function to the end of a Composition's
pipeline when given a" to correct the grammar.

Composition path.

## Supported languages

Expand Down
4 changes: 2 additions & 2 deletions cmd/crossplane/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ type cli struct {
// Subcommands.
Cluster cluster.Cmd `cmd:"" help:"Inspect a Crossplane cluster." maturity:"beta"`
Composition composition.Cmd `cmd:"" help:"Work with Crossplane Compositions."`
Config configcmd.Cmd `cmd:"" help:"View and modify the crossplane CLI config file."`
Config configcmd.Cmd `cmd:"" help:"View and update the crossplane CLI configuration file."`
Dependency dependency.Cmd `cmd:"" help:"Manage dependencies of control plane Projects." maturity:"beta"`
Function function.Cmd `cmd:"" help:"Work with functions in control plane Projects." maturity:"beta"`
Operation operation.Cmd `cmd:"" help:"Work with Crossplane Operations." maturity:"alpha"`
Expand All @@ -92,7 +92,7 @@ type cli struct {
GenerateDocs docsCmd `cmd:"" help:"Generate command-reference docs in markdown format." hidden:""`

// Flags.
ConfigPath string `env:"CROSSPLANE_CONFIG" help:"Path to the crossplane CLI config file." name:"config" placeholder:"PATH"`
ConfigPath string `env:"CROSSPLANE_CONFIG" help:"Path to the crossplane CLI configuration file." name:"config" placeholder:"PATH"`
Verbose verboseFlag `help:"Print verbose logging statements." name:"verbose"`

// Completion
Expand Down
25 changes: 13 additions & 12 deletions cmd/crossplane/project/help/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
The `project build` command builds a Crossplane Project into a set of xpkgs. It
The `project build` command builds a Crossplane Project into a set of xpkgs. It
builds each embedded function in the project and a Configuration package that
ties everything together. A special `.xpkg` file containing all the built
packages is written to the project's output directory (`_output/` by
default). This file can be consumed by the `project push` command to push the
packages to an OCI registry.

The repository for the built Configuration is taken from `spec.repository` in
`crossplane-project.yaml`. Override it for a single build with `--repository`.

> **Important:** The repository is used to construct the function names used for
> embedded function references in compositions. The same repository must be
> specified when building and pushing a project.
ties everything together. The output of the build is a special `.xpkg` file
containing all the built packages, placed in the project's output directory
(`_output/` by default). The `project push` command can consume packges from the
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix the typo: "packges" → "packages".

Line 5 contains a typo that was also flagged by the spell checker.

📝 Proposed fix 
-(`_output/` by default). The `project push` command can consume packges from the
+(`_output/` by default). The `project push` command can consume packages from the
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
(`_output/` by default). The `project push` command can consume packges from the
(`_output/` by default). The `project push` command can consume packages from the
🧰 Tools
🪛 LanguageTool

[grammar] ~5-~5: Ensure spelling is correct
Context: ... The project push command can consume packges from the output file and push them to a...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/help/build.md` at line 5, Fix the typo in the project
help text: replace the misspelled word "packges" with "packages" in the sentence
that mentions the `project push` command (the line containing "The `project
push` command can consume packges from the"). Ensure only the spelling is
corrected and punctuation/formatting remains unchanged.

output file and push them to an OCI registry.

The `build `command constructs the repository for the built Configuration from
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove the extra space in the backtick formatting.

Line 8 has an extra space between "build" and the closing backtick: `build ` should be `build`.

📝 Proposed fix 
-The `build `command constructs the repository for the built Configuration from
+The `build` command constructs the repository for the built Configuration from
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The `build `command constructs the repository for the built Configuration from
The `build` command constructs the repository for the built Configuration from
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/help/build.md` at line 8, The Markdown text contains
an extra space inside the inline code backticks for the build command; locate
the literal token "`build `" in the help text (the sentence starting "The `build
`command constructs...") and remove the trailing space so it reads "`build`"
(i.e., replace "`build `" with "`build`") to fix the formatting.

`spec.repository` in `crossplane-project.yaml`. Override it for a single build
with `--repository`.

> **Important:** The repository influences the function names used for embedded
> function references in compositions. You must specify the same repository when
> building and pushing a project.

The build reuses the dependency cache populated by `crossplane dependency add`
and `crossplane dependency update-cache`. Override the cache location with
Expand Down
4 changes: 2 additions & 2 deletions cmd/crossplane/project/help/init.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ creates a target directory containing a minimal `crossplane-project.yaml` along
with the standard sub-directories used by the DevEx tooling: `apis`,
`functions`, `examples`, `tests`, and `operations`.

The project name must be a valid DNS-1035 label. By default the project is
created in a new directory named after the project; use `--directory` (`-d`) to
The project name must be a valid DNS-1035 label. By default, the `init` command
creates a new directory named after the project; use `--directory` (`-d`) to
choose a different target directory.

## Examples
Expand Down
12 changes: 6 additions & 6 deletions cmd/crossplane/project/help/push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
The `project push` command pushes the xpkgs produced by `crossplane project
build` to an OCI registry. It pushes both the Configuration package and any
embedded function packages built from the project. Credentials for the registry
are taken from the local `docker` configuration; pushing to a private registry
may require a prior `docker login`.
embedded function packages built from the project. The `push` command uses
registry credentials from the local `docker` configuration; pushing to a private
registry may require a prior `docker login`.

By default the command pushes to the repository specified in
`crossplane-project.yaml` and uses a tag generated from the package contents.
Override either with `--repository` and `--tag` (`-t`). To push a specific
package file instead of the project's default output, use `--package-file`.

> **Important:** The repository is used to construct the function names used for
> embedded function references in compositions. The same repository must be
> specified when building and pushing a project.
> **Important:** The repository influences the function names used for embedded
> function references in compositions. You must specify the same repository when
> building and pushing a project.

## Examples

Expand Down
8 changes: 4 additions & 4 deletions cmd/crossplane/project/help/run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ This command:
- Installs the project's Configuration on the control plane.
- Updates kubeconfig so `kubectl` points at the development control plane.

By default the control plane is named after the project. Use
By default, `run` names the control plane after the project. Use
`--control-plane-name` to choose a different name, which is useful when running
multiple projects side-by-side.

The Crossplane version installed in the dev control plane can be pinned with
`--crossplane-version`; otherwise the latest stable version is used.
You can use a Crossplane version other than the latest stable version by
specifying the `--crossplane-version` flag.

Resources can be applied around the project install:
You can provide resources to apply around the project install:

- `--init-resources` applies one or more files *before* installing the
Configuration (useful for things like `ImageConfig`).
Expand Down
13 changes: 7 additions & 6 deletions cmd/crossplane/project/help/stop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
The `project stop` command tears down the local development control plane
previously created by `crossplane project run`. The KIND cluster and the local
OCI registry are both removed.
created by `crossplane project run`. It removes both the KIND cluster and the
local OCI registry.

When run from a project directory the control plane name is derived from the
project name. When run outside a project directory, pass `--control-plane-name`
to identify the control plane to tear down. Pass `--registry-dir` to point at
the local registry directory used by `project run` if it was overridden there.
When run from a project directory, the `stop` command tears down the control
plane whose name matches the project name. When run outside a project directory,
pass `--control-plane-name` to identify the control plane to tear down. If you
passed `--registry-dir` to `up project run`, pass it to `up project stop` as
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Correct the command references: "up project" → "crossplane project".

Line 8 references up project run and up project stop, but the correct command names are crossplane project run and crossplane project stop. This would confuse users trying to follow the documentation.

📝 Proposed fix 
-passed `--registry-dir` to `up project run`, pass it to `up project stop` as
+passed `--registry-dir` to `crossplane project run`, pass it to `crossplane project stop` as
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
passed `--registry-dir` to `up project run`, pass it to `up project stop` as
passed `--registry-dir` to `crossplane project run`, pass it to `crossplane project stop` as
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/help/stop.md` at line 8, Replace the incorrect command
references 'up project run' and 'up project stop' in the stop.md content with
the correct commands 'crossplane project run' and 'crossplane project stop' so
the README/documentation accurately reflects the CLI; locate the offending
strings (e.g., "passed `--registry-dir` to `up project run`, pass it to `up
project stop` as") and update them to use "crossplane project run" and
"crossplane project stop".

well to clean up the registry data.

## Examples

Expand Down
Loading
Loading