CLI Reference
Nebi’s CLI is organized into command groups: Workspace, Sync, Connection, and Admin.
Specs vs. Bundles
Section titled “Specs vs. Bundles”Two terms appear throughout these commands:
- Workspace spec:
pixi.tomlandpixi.lock. The minimal environment definition. Stored on the Nebi server. - Workspace bundle:
pixi.toml+pixi.lock+ any project files (READMEs, source code, data), packaged for an OCI registry.
Workspace Commands
Section titled “Workspace Commands”| Command | Description |
|---|---|
nebi init |
Track current directory as a workspace (runs pixi init if needed) |
nebi status |
Show workspace sync status |
nebi workspace list |
List tracked workspaces |
nebi workspace install <name> |
Install a server workspace’s environment from its lockfile (local mode) |
nebi workspace uninstall <name> |
Remove a server workspace’s installed environment (local mode) |
nebi workspace remove <name> |
Remove a workspace from tracking |
nebi workspace prune |
Remove workspaces whose paths no longer exist |
nebi shell [name] [pixi-args...] |
Activate a pixi shell |
nebi run [name] [pixi-args...] |
Run a command or task via pixi |
Sync Commands
Section titled “Sync Commands”| Command | Description |
|---|---|
nebi push [<name>][:<tag>] |
Push workspace specs to a server (tag optional, auto-tags with content hash + latest) |
nebi pull [<name>[:<tag>]] |
Pull workspace specs from a server |
nebi diff [<ref-a>] [<ref-b>] |
Compare workspace specs |
nebi publish [name] |
Publish a workspace bundle to an OCI registry (uses content hash tag by default) |
nebi import <oci-reference> |
Import a workspace bundle from an OCI registry, restoring pixi files and asset layers (a bare name or a <registry-name>: prefix resolves against the local registries) |
Connection Commands
Section titled “Connection Commands”| Command | Description |
|---|---|
nebi login <server-url> |
Authenticate with a server |
nebi registry list |
List available OCI registries |
nebi registry add |
Add an OCI registry |
nebi registry remove <name> |
Remove an OCI registry |
Admin Commands
Section titled “Admin Commands”| Command | Description |
|---|---|
nebi serve |
Run a Nebi server instance |
publish
--local: Publish directly to registry without a server--tag <tag>: Set the OCI tag (default: content hash with--local, auto-incrementingv1,v2, … otherwise)--repo <name>: Set the OCI repository name (defaults to the workspace name)--registry <name>: Registry name or ID to publish to (defaults to the configured default registry)--concurrency N: Number of files uploaded at the same time (only with--local, default 8)
import
-o, --output <dir>: Output directory (defaults to current directory)--concurrency N: Number of files downloaded at the same time (default 8)--force: Overwrite an existingpixi.tomlwithout asking. Only applies when the bundle contains just pixi files; bundles with other files always refuse to overwrite.
workspace list, workspace remove
-r, --remote: Use workspaces from the Nebi server instead of local workspaces--installed(workspace listonly): Only list server workspaces with an installed environment; implies--remote