config-forge 0.4.0

A CLI tool for converting, inspecting, and validating configuration files.
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

# ConfigForge

ConfigForge is a Rust CLI tool for converting, inspecting, validating, querying, and safely editing configuration files.

The first implementation milestone supports conversion between:

- JSON
- TOML
- YAML

## Install

```bash
cargo install config-forge
```

## Usage

```bash
config-forge --help
config-forge inspect Cargo.toml
config-forge convert app.toml -o app.yaml
config-forge convert app.yaml --to json
config-forge convert app.toml --to yaml --check
config-forge validate app.yaml
config-forge get app.toml server.port
config-forge get app.yaml items.0.name
config-forge get app.toml server --to yaml
config-forge set app.yaml server.host prod -o app.updated.yaml
config-forge set app.json server.port 9090 --value-format json -o app.updated.json
config-forge delete app.yaml server.debug -o app.updated.yaml
config-forge merge base.yaml override.yaml -o merged.yaml
config-forge diff old.toml new.toml
```

When writing converted content to stdout, pass `--to` so the output format is explicit:

```bash
config-forge convert app.toml --to json
```

ConfigForge does not overwrite existing output files by default. Pass `--overwrite` when replacing a file is intentional:

```bash
config-forge convert app.toml -o app.yaml --overwrite
```

`get` reads values by dot path. Numeric path segments index arrays:

```bash
config-forge get app.yaml server.port
config-forge get app.yaml items.0.name
```

`set` and `delete` update existing paths only and require an output file. They do not modify the input file in place:

```bash
config-forge set app.yaml server.host prod -o app.updated.yaml
config-forge set app.json server.port 9090 --value-format json -o app.updated.json
config-forge delete app.yaml items.0 -o app.updated.yaml
```

By default, `set` treats the replacement as a string. Pass `--value-format json` for numbers, booleans, arrays, objects, or null.

`merge` recursively combines object values. Override scalar values and arrays replace the base value:

```bash
config-forge merge base.yaml override.yaml -o merged.yaml
config-forge merge base.yaml override.json -o merged.toml --to toml
```

`diff` prints path-oriented changes:

```bash
config-forge diff old.yaml new.yaml
```

Example output:

```text
changed server.port
removed server.debug
added server.timeout
```

## Package Check

Before publishing a release build:

```bash
cargo publish -p config-forge --dry-run
```

Release tags use this format:

```bash
git tag config-forge-v0.4.0
git push <remote> config-forge-v0.4.0
```