miniximg-cli 1.0.0

A CLI for building, inspecting, validating, and editing Minix v1 filesystem images
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

# miniximg-cli

`miniximg-cli` provides the `miniximg` command-line interface on top of
`miniximg-core`.

The binary keeps parsing, manifest loading, and text rendering in the CLI crate
while delegating all filesystem logic to the core library.

## Commands

### Build

Create a new image from either a TOML manifest or repeated `--entry` flags.

```bash
miniximg build --manifest rootfs.toml
```

```bash
miniximg build \
  --output build/rootfs.img \
  --size 4MiB \
  --inode-count 128 \
  --entry kind=tree,source=build/root,target=/,overwrite=true \
  --entry kind=file,source=README.md,target=/etc/motd,overwrite=true
```

### Inspect And Validate

```bash
miniximg inspect build/rootfs.img
miniximg check build/rootfs.img
```

### Read-Only Image Access

```bash
miniximg ls build/rootfs.img /
miniximg tree build/rootfs.img /
miniximg stat build/rootfs.img /bin/init
miniximg cat build/rootfs.img /etc/motd
miniximg get build/rootfs.img /etc/motd --output out/motd
```

### Mutating Image Operations

```bash
miniximg mkdir build/rootfs.img /usr/share
miniximg mknod build/rootfs.img /dev/tty0 --kind char --major 4 --minor 0
miniximg put build/rootfs.img host/message.txt /usr/share/message --overwrite
miniximg mv build/rootfs.img /usr/share/message /usr/share/motd
miniximg ln build/rootfs.img /usr/share/motd /etc/motd
miniximg rm build/rootfs.img /usr/share/motd
miniximg rmdir build/rootfs.img /usr/share
```

## Manifest Shape

`build --manifest` expects a TOML file with one `[image]` table and zero or
more `[[mapping]]` entries.

```toml
[image]
output = "build/rootfs.img"
size = "4MiB"
inode_count = 128
default_uid = 0
default_gid = 0
default_file_mode = "0644"
default_dir_mode = "0755"

[[mapping]]
kind = "tree"
source = "build/root"
target = "/"
overwrite = true

[[mapping]]
kind = "file"
source = "README.md"
target = "/etc/motd"
overwrite = true

[[mapping]]
kind = "dir"
target = "/var/log"
mode = "0755"

[[mapping]]
kind = "char-device"
target = "/dev/tty0"
major = 4
minor = 0
mode = "0666"
```

Supported mapping kinds:

- `file`
- `tree`
- `dir`
- `block-device`
- `char-device`

## Development

Run tests:

```bash
cargo test
```

Run Clippy:

```bash
cargo clippy --all-targets --all-features -- -D warnings
```