Skip to main content

CLI Reference

Nebi's CLI is organized into command groups: Workspace, Sync, Connection, and Admin.

Specs vs. Bundles

Two terms appear throughout these commands:

  • Workspace spec: pixi.toml and pixi.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

CommandDescription
nebi initTrack current directory as a workspace (runs pixi init if needed)
nebi statusShow workspace sync status
nebi workspace listList tracked workspaces
nebi workspace remove <name>Remove a workspace from tracking
nebi workspace pruneRemove 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

CommandDescription
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

Connection Commands

CommandDescription
nebi login <server-url>Authenticate with a server
nebi registry listList available OCI registries
nebi registry addAdd an OCI registry
nebi registry remove <name>Remove an OCI registry

Admin Commands

CommandDescription
nebi serveRun a Nebi server instance

Flags

publish

  • --local: Publish directly to registry without a server
  • --tag <tag>: Set the OCI tag (default: content hash with --local, auto-incrementing v1, 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 existing pixi.toml without 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