NEBULA

NEBULA-GET-STARTED(1)

Nebula Manual

NAMEget started — Build Nebula from source, initialize a local galaxy, save workspace state, and create your first proposal.
SOURCEnebula/README.md and nebula/docs/local-cli-loop.md
STATUSpre-alpha · protocol in design
01

Prerequisites

Nebula requires Rust 1.89 or newer. The CLI is built from source until the first validated public release tag.

  • →Rust 1.89 or newer
  • →Cargo (included with Rust)
  • →Optional: Postgres for registry production validation
  • →Optional: S3-compatible object storage for blob persistence
02

Build from source

There are no published binary installers yet, so building from source is the only supported install path. Clone the repository and install the `neb` binary onto your `PATH` with Cargo. Note that the repository is currently private — you'll need collaborator access to clone it.

output
git clone https://github.com/HelixHEX/Nebula.git
cd Nebula
cargo install --path crates/nebula-cli

# Verify it worked
neb --help
03

Iterating on Nebula itself

If you're developing Nebula rather than just using the CLI, build and run in place instead so you don't need to reinstall on every change.

output
cargo build --workspace
cargo run -p nebula-cli -- init
cargo run -p nebula-cli -- status
04

Initialize a local repository

Initialize creates the local `.nebula` metadata directory with all required subdirectories for refs, workspaces, objects, policies, environments, integrations, and secrets.

output
neb init
neb status
neb diff
05

Save workspace state

The save command scans the working tree, computes content hashes, and records a canonical snapshot with an associated changeset.

output
neb save --message "Initial implementation draft"
06

Work with workspaces

Workspaces isolate work from the main branch. Create one to work on a feature or fix without affecting shared state.

output
neb workspace create auth-fix --from main
neb workspace list
neb workspace switch auth-fix
07

Propose and merge changes

Proposals are reviewable protocol objects. They group changesets and track review state before composition into a ref.

output
neb propose --target main --title "Fix auth redirect"
neb proposal list
neb proposal status <proposal-id>
neb merge <proposal-id>
08

Push and pull bundles

Nebula supports local file-backed sync bundles. Network registry sync is the next transport layer.

output
neb remote add origin file:///tmp/acme-app.nebula.json
neb push
neb pull origin
neb clone file:///tmp/acme-app.nebula.json