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:
- Open the GitHub Releases page.
- Choose the latest
cli-v*release. - Download the asset for your platform.
- Verify the matching
.sha256file if possible. - Put the
ocibinary somewhere in yourPATH.
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 config
Command Structure
oci encode <INPUT> --space <SPACE> [--format json|pretty] [--precision <N>]
oci inspect <OCI_ID> [--format json|pretty] [--exports all|none|summary|<LIST>]
oci export <OCI_ID> --to <TARGETS> [--format json|plain|pretty]
oci convert <INPUT> --from <SPACE> --to <TARGETS> [--format json|plain|pretty]
oci registry <SUBCOMMAND>
oci test <SUBCOMMAND>
oci validate <TARGET> [--type id|registry|color]
oci config [--path <TOML_PATH>]
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.
Relationship to the Kernel
The CLI is only a client. The actual color kernel is in the root crate.
License
Apache-2.0.