orrery-cli 0.4.1

Command-line interface for the Orrery diagram language
Documentation 
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

# Orrery CLI

Command-line interface for the Orrery diagram language.

## Installation

Install from source:

```bash
cargo install --path .
```

Or from crates.io:

```bash
cargo install orrery-cli
```

### Optional Features

- `graphviz` *(enabled by default)* — Enables the Graphviz-backed layout engine for component diagrams. Requires the `dot` command-line tool to be installed (see <https://graphviz.org/download/>).

```bash
# Install without the Graphviz layout engine
cargo install --path . --no-default-features

# Or from crates.io
cargo install orrery-cli --no-default-features
```

## Usage

```bash
orrery <input.orr> [OPTIONS]
```

### Basic Example

```bash
# Render a diagram to SVG
orrery diagram.orr -o output.svg

# With custom configuration
orrery diagram.orr -o output.svg --config custom.toml

# With debug logging
orrery diagram.orr -o output.svg --log-level debug
```

### Command-Line Options

```
Arguments:
  <INPUT>  Path to the input Orrery file

Options:
  -o, --output <OUTPUT>        Path to output SVG file [default: out.svg]
  -c, --config <CONFIG>        Path to configuration file (TOML)
      --log-level <LOG_LEVEL>  Log level (off, error, warn, info, debug, trace) [default: info]
  -h, --help                   Print help
  -V, --version                Print version
```

## Configuration

The CLI searches for configuration files in this order:

1. Path specified with `--config` flag
2. `orrery/config.toml` in current directory
3. Platform-specific config directory:
   - Linux: `~/.config/orrery/config.toml`
   - macOS: `~/Library/Application Support/com.orrery.orrery/config.toml`
   - Windows: `%APPDATA%\orrery\orrery\config.toml`

### Example Configuration

```toml
[layout]
component = "sugiyama"
sequence = "basic"

[style]
background_color = "#ffffff"

[style.lifeline]
color = "#000000"
width = 2.0
style = "solid"
```

## Example Diagrams

See the [examples directory](../../examples/) for sample `.orr` files.

Process an example:

```bash
orrery examples/component_shapes.orr -o showcase.svg
```

## License

Licensed under either of Apache License 2.0 or MIT license at your option.