diff --git a/docs/reference/cli-reference.md b/docs/reference/cli-reference.md index 9dcfdc1..0c6e567 100644 --- a/docs/reference/cli-reference.md +++ b/docs/reference/cli-reference.md @@ -193,7 +193,7 @@ occ scaffold component [flags] - `--project` - Project name (can be omitted if set in context) - `-o, --output-file` - Write output to specified file instead of stdout - `--skip-comments` - Skip section headers and field description comments for minimal output -- `--skip-optional` - Skip optional fields without defaults +- `--skip-optional` - Skip fields with defaults **Examples:** ```bash diff --git a/docs/user-guide/cli-installation.mdx b/docs/user-guide/cli-installation.mdx new file mode 100644 index 0000000..d4ddf29 --- /dev/null +++ b/docs/user-guide/cli-installation.mdx @@ -0,0 +1,75 @@ +--- +title: CLI Installation +description: Install the OpenChoreo CLI (occ) on macOS, Linux, and Windows +--- + +import CodeBlock from '@theme/CodeBlock'; +import {versions} from '../_constants.mdx'; + +# CLI Installation + +The OpenChoreo CLI (`occ`) is the command-line interface for managing OpenChoreo resources, projects, and deployments. + +## Installation + +{versions.dockerTag === 'latest-dev' ? ( +<> +First, download the latest development build from GitHub: + + +{`curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip +unzip occ.zip`} + + +Use the appropriate platform binary for the next step + + + + +{`# Use the appropriate platform suffix (e.g., darwin/arm64, linux/amd64) +chmod +x /occ +sudo mv /occ /usr/local/bin/`} + + +) : ( +<> +First, download the appropriate binary from the{' '} + + GitHub release + +: + + + +macOS/Linux: + + +{`tar -xzf occ_${versions.dockerTag}_.tar.gz +chmod +x occ +sudo mv occ /usr/local/bin/`} + + +)} + +### Verify Installation + + +{`occ version`} + + +## See Also +- **CLI Reference:** [CLI Reference](/docs/reference/cli-reference) diff --git a/sidebars.ts b/sidebars.ts index 036e5f0..9b7ffc9 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -100,6 +100,13 @@ const sidebars: SidebarsConfig = { type: 'category', label: 'User Guide', items: [ + { + type: 'category', + label: 'CLI', + items: [ + {type: 'doc', id: 'user-guide/cli-installation', label: 'Installation'}, + ], + }, { type: 'category', label: 'CI', diff --git a/versioned_docs/version-v0.11.x/reference/cli-reference.md b/versioned_docs/version-v0.11.x/reference/cli-reference.md index 9dcfdc1..0c6e567 100644 --- a/versioned_docs/version-v0.11.x/reference/cli-reference.md +++ b/versioned_docs/version-v0.11.x/reference/cli-reference.md @@ -193,7 +193,7 @@ occ scaffold component [flags] - `--project` - Project name (can be omitted if set in context) - `-o, --output-file` - Write output to specified file instead of stdout - `--skip-comments` - Skip section headers and field description comments for minimal output -- `--skip-optional` - Skip optional fields without defaults +- `--skip-optional` - Skip fields with defaults **Examples:** ```bash diff --git a/versioned_docs/version-v0.11.x/user-guide/cli-installation.mdx b/versioned_docs/version-v0.11.x/user-guide/cli-installation.mdx new file mode 100644 index 0000000..d4ddf29 --- /dev/null +++ b/versioned_docs/version-v0.11.x/user-guide/cli-installation.mdx @@ -0,0 +1,75 @@ +--- +title: CLI Installation +description: Install the OpenChoreo CLI (occ) on macOS, Linux, and Windows +--- + +import CodeBlock from '@theme/CodeBlock'; +import {versions} from '../_constants.mdx'; + +# CLI Installation + +The OpenChoreo CLI (`occ`) is the command-line interface for managing OpenChoreo resources, projects, and deployments. + +## Installation + +{versions.dockerTag === 'latest-dev' ? ( +<> +First, download the latest development build from GitHub: + + +{`curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip +unzip occ.zip`} + + +Use the appropriate platform binary for the next step + + + + +{`# Use the appropriate platform suffix (e.g., darwin/arm64, linux/amd64) +chmod +x /occ +sudo mv /occ /usr/local/bin/`} + + +) : ( +<> +First, download the appropriate binary from the{' '} + + GitHub release + +: + + + +macOS/Linux: + + +{`tar -xzf occ_${versions.dockerTag}_.tar.gz +chmod +x occ +sudo mv occ /usr/local/bin/`} + + +)} + +### Verify Installation + + +{`occ version`} + + +## See Also +- **CLI Reference:** [CLI Reference](/docs/reference/cli-reference) diff --git a/versioned_sidebars/version-v0.11.x-sidebars.json b/versioned_sidebars/version-v0.11.x-sidebars.json index 504b6df..e40dc0a 100644 --- a/versioned_sidebars/version-v0.11.x-sidebars.json +++ b/versioned_sidebars/version-v0.11.x-sidebars.json @@ -86,6 +86,13 @@ "type": "category", "label": "User Guide", "items": [ + { + "type": "category", + "label": "CLI", + "items": [ + "user-guide/cli-installation" + ] + }, { "type": "category", "label": "CI",