​
Ocuroot CLI

The Ocuroot Command Line Interface (CLI) is an all-in-one binary that provides all the functionality of Ocuroot. It allows you to manage builds, deployments, environments, and more, all from your terminal, as well as run an Ocuroot server.

​
Key Features

  • Local Development: Run the same processes locally as in your CI system
  • Offline Testing: Test your build and deployment logic locally without affecting server state
  • Environment Management: Create, configure, and manage deployment environments
  • Build Control: Build and manage package versions
  • Deployment Management: Deploy and track package versions across environments
  • State Management: Import, export, and synchronize system state
  • Review Process: Run review functions on modified code

​
Installation

[Installation instructions to be added]

​
Getting Started

  1. Environment Setup: Create your first environment: 
    ocuroot environment create production
  2. Build and Deploy: Build and deploy your first package: 
    # Test your build logic locally
ocuroot build MyPackage

# Test your deployment logic
ocuroot deploy MyPackage [build-id] production

​
Command Categories

The Ocuroot CLI commands are organized into several categories:

​
Core Operations

  • Building and deploying packages
  • Managing environments
  • Running reviews
  • Synchronizing state

​
State Management

  • Importing and exporting state
  • Managing configurations
  • Handling system state

​
Server Operations

  • Starting and managing the Ocuroot server
  • Managing server secrets
For detailed information about specific commands, refer to the Commands Reference.