oci-cli 0.3.3

Command-line client for Open Chroma Index.
oci-cli-0.3.3 is not a library.

OCI CLI

A command-line client for Open Chroma Index.

What is this?

This crate provides the oci command-line tool. It uses the Open Chroma Index kernel from the root project.

For the standard, registry, color model, and Rust library, see the main project README:

../README.md

Install

Install the latest cli-v* release on macOS or Linux:

curl -fsSL https://raw.githubusercontent.com/T-1234567890/open-chroma-index/main/install.sh | bash

Install a specific CLI release:

curl -fsSL https://raw.githubusercontent.com/T-1234567890/open-chroma-index/main/install.sh | bash -s -- --version cli-v0.1.0

Install to a custom directory:

curl -fsSL https://raw.githubusercontent.com/T-1234567890/open-chroma-index/main/install.sh | bash -s -- --dir ~/.local/bin --force

Install system-wide:

curl -fsSL https://raw.githubusercontent.com/T-1234567890/open-chroma-index/main/install.sh | bash -s -- --system

From source:

cargo install --path cli

During development:

cargo run -p oci-cli -- encode "#E85A9A" --space hex

Manual fallback:

  1. Open the GitHub Releases page.
  2. Choose the latest cli-v* release.
  3. Download the asset for your platform.
  4. Verify the matching .sha256 file if possible.
  5. Put the oci binary somewhere in your PATH.

Windows:

Download oci-x86_64-pc-windows-msvc.zip manually from GitHub Releases. A PowerShell installer is not included yet.

Basic Usage

oci encode "#E85A9A" --space hex
oci inspect OCI-1-48RS-327
oci export OCI-1-48RS-327 --to hex,oklch,css
oci registry info
oci swatch gen --id OCI-1-22TL-326 --template Color_Cards_OCI_v1.svg --out out/
oci serve
oci update
oci config

Command Structure

oci encode <INPUT> --space <SPACE> [--format json|pretty] [--precision <N>] [--verify]
oci inspect <OCI_ID> [--format json|pretty] [--exports all|none|summary|<LIST>] [--verify]
oci export <OCI_ID> --to <TARGETS> [--format json|plain|pretty] [--verify]
oci convert <INPUT> --from <SPACE> --to <TARGETS> [--format json|plain|pretty] [--verify]
oci serve [--host <HOST>] [--port <PORT>] [--config <PATH>] [--json]
oci swatch gen (--id <OCI_ID>|--family <INDEX_OR_CODE>|--range <START>..<END>) --out <DIR> [--template <SVG_PATH>] [--filename short|full] [--overwrite]
oci swatch data --id <OCI_ID>
oci update [--version <TAG>] [--dir <PATH>] [--system] [--no-checksum] [--force]
oci registry <SUBCOMMAND>
oci test <SUBCOMMAND>
oci validate <TARGET> [--type id|registry|color]
oci config [--path <TOML_PATH>]

Swatch Cards

oci swatch gen renders SVG swatch cards from Color_Cards_OCI_v1.svg. oci swatch data --id <OCI_ID> prints the placeholder data JSON for template authors. For full placeholder and range documentation, see ../docs/swatch-templates.md.

Local Kernel API

Start the Local Kernel API:

oci serve

Default address:

http://127.0.0.1:8765

Endpoint summary:

GET  /v1/health
POST /v1/encode
POST /v1/inspect
POST /v1/export
POST /v1/convert
GET  /v1/registry/info
GET  /v1/registry/families
GET  /v1/registry/family/{indexOrCode}
GET  /v1/registry/step/{idOrStep}

The server is local by default and returns JSON envelopes for every endpoint. For request and response examples, see the main project documentation: ../docs/local-api.md.

Updates

oci update runs the project install script and installs the latest cli-v* release by default.

oci update
oci update --version cli-v0.3.2
oci update --dir ~/.local/bin
oci update --system

During normal human-readable commands, the CLI checks GitHub Releases for a newer cli-v* release. It shows the update notice up to three times for the same available release, then stops showing it. JSON output is not changed by update notices.

Config

The CLI supports TOML config.

Default config location:

<oci-install-dir>/config.toml

Open interactive config:

oci config

Use custom config:

oci config --path ./path/to/config.toml

Output Formats

pretty is default for humans.

json is available for automation.

plain is available for minimal scripting.

Pretty output shows clean export values plus a compact verification block. Use --verify for detailed per-target status and round-trip errors.

Relationship to the Kernel

The CLI is only a client. The actual color kernel is in the root crate.

License

Apache-2.0.