oci-cli 0.1.0

Command-line client for Open Chroma Index.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# 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:

```text
../README.md
```

## Install

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

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

Install a specific CLI release:

```text
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:

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

Install system-wide:

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

From source:

```text
cargo install --path cli
```

During development:

```text
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

```text
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

```text
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:

```text
<oci-install-dir>/config.toml
```

Open interactive config:

```text
oci config
```

Use custom config:

```text
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.