fuselage 0.4.0

Linux CLI tool for running commands with ephemeral, namespace-private filesystems
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

# Contributing to fuselage

## Prerequisites

Building and testing fuselage requires the following tools.

### Quick setup (Debian/Ubuntu)

```bash
bash scripts/jumpstart.sh
```

This installs everything listed below in one step.

### Manual setup

| Tool | Package / installer | Purpose |
|------|---------------------|---------|
| Rust ≥ 1.85 (stable) | [rustup.rs](https://rustup.rs) | Build the Rust binaries |
| `gcc` | `apt install build-essential` | Compile the self-executing stub |
| `mksquashfs` | `apt install squashfs-tools` | Create squashfs archives |
| `uv` | [astral.sh/uv](https://astral.sh/uv) | Sync Python dependencies in `uv-bundle` |
| `just` | `cargo install just` | Task runner for build/test recipes |
| `musl-gcc` *(optional)* | `apt install musl-tools` | Produce smaller stubs (~50 KB vs ~700 KB) |

## Building

```bash
cargo build           # debug build
cargo build --release # release build
```

## Testing

```bash
just test             # unit tests + lint + format check + audit + functest (debug + setuid)
just unittest         # cargo test only
just functest-debug   # functional tests against the debug build (plain mode)
just functest-setuid  # functional tests against a setuid release build
```

The setuid functional tests require `fuselage` to be setuid-root. `just functest-setuid`
handles this automatically, using `sudo` to set the owner and the setuid bit.

## Code style

See [CLAUDE.md](CLAUDE.md) for the full style guide. Key points:

- 4-space indentation, spaces only, LF line endings.
- Maximum line length: 120 characters (first-to-last non-whitespace).
- Comments are proper sentences (capital letter, period), except short phrases or bullet points.

## Design decisions

Significant design choices are recorded in [docs/decisions/](docs/decisions/) using
the template in that directory.