Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/reference/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
75 changes: 75 additions & 0 deletions docs/user-guide/cli-installation.mdx
Original file line number Diff line number Diff line change
@@ -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:

<CodeBlock language="bash">
{`curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip
unzip occ.zip`}
</CodeBlock>

Use the appropriate platform binary for the next step

<ul>
<li><strong>macOS (Intel)</strong>: <code>darwin/amd64</code></li>
<li><strong>macOS (Apple Silicon)</strong>: <code>darwin/arm64</code></li>
<li><strong>Linux (x64)</strong>: <code>linux/amd64</code></li>
<li><strong>Linux (ARM)</strong>: <code>linux/arm64</code></li>
</ul>

<CodeBlock language="bash">
{`# Use the appropriate platform suffix (e.g., darwin/arm64, linux/amd64)
chmod +x <platform>/occ
sudo mv <platform>/occ /usr/local/bin/`}
</CodeBlock>
</>
) : (
<>
First, download the appropriate binary from the{' '}
<a
href={`https://github.com/openchoreo/openchoreo/releases/tag/${versions.dockerTag}`}
target="_blank"
rel="noopener noreferrer"
>
GitHub release
</a>
:

<ul>
<li><strong>macOS (Intel)</strong>: <code>{`occ_${versions.dockerTag}_darwin_amd64.tar.gz`}</code></li>
<li><strong>macOS (Apple Silicon)</strong>: <code>{`occ_${versions.dockerTag}_darwin_arm64.tar.gz`}</code></li>
<li><strong>Linux (x64)</strong>: <code>{`occ_${versions.dockerTag}_linux_amd64.tar.gz`}</code></li>
<li><strong>Linux (ARM)</strong>: <code>{`occ_${versions.dockerTag}_linux_arm64.tar.gz`}</code></li>
</ul>

<b>macOS/Linux:</b>

<CodeBlock language="bash">
{`tar -xzf occ_${versions.dockerTag}_<platform>.tar.gz
chmod +x occ
sudo mv occ /usr/local/bin/`}
</CodeBlock>
</>
)}

### Verify Installation

<CodeBlock language="bash">
{`occ version`}
</CodeBlock>

## See Also
- **CLI Reference:** [CLI Reference](/docs/reference/cli-reference)
7 changes: 7 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-v0.11.x/reference/cli-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
75 changes: 75 additions & 0 deletions versioned_docs/version-v0.11.x/user-guide/cli-installation.mdx
Original file line number Diff line number Diff line change
@@ -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:

<CodeBlock language="bash">
{`curl -L https://nightly.link/openchoreo/openchoreo/workflows/build-and-test/main/occ.zip -o occ.zip
unzip occ.zip`}
</CodeBlock>

Use the appropriate platform binary for the next step

<ul>
<li><strong>macOS (Intel)</strong>: <code>darwin/amd64</code></li>
<li><strong>macOS (Apple Silicon)</strong>: <code>darwin/arm64</code></li>
<li><strong>Linux (x64)</strong>: <code>linux/amd64</code></li>
<li><strong>Linux (ARM)</strong>: <code>linux/arm64</code></li>
</ul>

<CodeBlock language="bash">
{`# Use the appropriate platform suffix (e.g., darwin/arm64, linux/amd64)
chmod +x <platform>/occ
sudo mv <platform>/occ /usr/local/bin/`}
</CodeBlock>
</>
) : (
<>
First, download the appropriate binary from the{' '}
<a
href={`https://github.com/openchoreo/openchoreo/releases/tag/${versions.dockerTag}`}
target="_blank"
rel="noopener noreferrer"
>
GitHub release
</a>
:

<ul>
<li><strong>macOS (Intel)</strong>: <code>{`occ_${versions.dockerTag}_darwin_amd64.tar.gz`}</code></li>
<li><strong>macOS (Apple Silicon)</strong>: <code>{`occ_${versions.dockerTag}_darwin_arm64.tar.gz`}</code></li>
<li><strong>Linux (x64)</strong>: <code>{`occ_${versions.dockerTag}_linux_amd64.tar.gz`}</code></li>
<li><strong>Linux (ARM)</strong>: <code>{`occ_${versions.dockerTag}_linux_arm64.tar.gz`}</code></li>
</ul>

<b>macOS/Linux:</b>

<CodeBlock language="bash">
{`tar -xzf occ_${versions.dockerTag}_<platform>.tar.gz
chmod +x occ
sudo mv occ /usr/local/bin/`}
</CodeBlock>
</>
)}

### Verify Installation

<CodeBlock language="bash">
{`occ version`}
</CodeBlock>

## See Also
- **CLI Reference:** [CLI Reference](/docs/reference/cli-reference)
7 changes: 7 additions & 0 deletions versioned_sidebars/version-v0.11.x-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,13 @@
"type": "category",
"label": "User Guide",
"items": [
{
"type": "category",
"label": "CLI",
"items": [
"user-guide/cli-installation"
]
},
{
"type": "category",
"label": "CI",
Expand Down