Getting Started

Bring up the local core fast.

One binary holds the CLI, the daemon, the admin console and the optional facades. The commands below are the fastest path from a checkout to real bytes in and real bytes out, surviving restart, with every operation signed and verified.

cargo build -p nexusfs
# node.data_dir must live outside any synced folder
cp examples/nexusfs.toml ./nexusfs.toml

cargo run -p nexusfs -- mkdir --config ./nexusfs.toml /docs
echo "hello nexus" > /tmp/a.txt
cargo run -p nexusfs -- put   --config ./nexusfs.toml /tmp/a.txt /docs/a.txt
cargo run -p nexusfs -- ls    --config ./nexusfs.toml /docs
cargo run -p nexusfs -- cat   --config ./nexusfs.toml /docs/a.txt
cargo run -p nexusfs -- status --config ./nexusfs.toml

# the admin console comes up on :7070
cargo run -p nexusfs -- daemon --config ./nexusfs.toml

What happens on first run

The daemon opens the local storage backend.
It refuses to run against an on-disk format it does not understand.
A persistent device identity is created if missing.
An initial repository head is bootstrapped.
The admin surface starts with a generated access token.

The embedded database takes an exclusive lock, so status cannot run while the daemon holds the store — query the running daemon through the admin API instead.

Turning on more of it

Replication, the S3 facade and the console are feature flags on the same binary. admin is on by default; quic and s3 are opt-in.

cargo build -p nexusfs --features "admin,quic,s3"
# two nodes, seeded apart, converging on one state root
./scripts/dev_run_two_nodes.sh