miniximg-cli 1.1.0

Command-line tool for building, inspecting, editing, and interactively exploring 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

# miniximg-cli

> Command-line tool for building, inspecting, editing, and interactively
> exploring [Minix v1 filesystem][minix] images.

`miniximg-cli` ships the `miniximg` binary. It glues
[`miniximg`](https://crates.io/crates/miniximg) (the core library) and
[`miniximg-shell`](https://crates.io/crates/miniximg-shell) (the
interactive REPL) into a single tool.

```bash
cargo install miniximg-cli
```

[minix]: https://en.wikipedia.org/wiki/MINIX_file_system

## At a glance

| Subcommand       | One-liner                                                     |
|------------------|---------------------------------------------------------------|
| `build`          | Create a new image from a TOML manifest or `--entry` flags.   |
| `inspect`        | Print a human-readable summary of an existing image.          |
| `check`          | Validate an image and exit non-zero on issues.                |
| `ls`, `tree`, `cat`, `stat` | Read-only browsing.                                |
| `get`, `put`     | Transfer one file between the host and an image.              |
| `mkdir`, `mknod`, `rm`, `rmdir`, `mv`, `ln` | Direct mutating ops.        |
| `shell`          | Drop into an interactive REPL against the image.              |

Run `miniximg <subcommand> --help` for the full set of flags on any one
command.

## Build an image

From a TOML manifest:

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

Or with explicit mappings on the command line:

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

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

## Inspect and validate

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

## Read-only browsing

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

## Mutating 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
```

## Interactive shell

For ad-hoc exploration and editing, `shell` is much faster than chaining
individual subcommands.

```bash
miniximg shell build/rootfs.img            # read-write
miniximg shell --readonly build/rootfs.img # safe browsing
```

```text
(rootfs.img) /> ls /etc
group  hostname  motd  passwd  profile  rc
(rootfs.img) /> edit /etc/motd           # opens $EDITOR, writes back on save
(rootfs.img) /> put @./local-fix.sh /usr/local/bin/fix
(rootfs.img) /> diff /etc/motd @./old-motd
```

See [`miniximg-shell`](https://crates.io/crates/miniximg-shell) for the
full command list, prompt syntax, and the `@`-prefix convention.

## License

MIT. See [LICENSE](../../LICENSE) in the workspace root.