nb-fabric 0.4.0

Open beta. Commands and flags may change between versions. Pin your version if stability matters.

Install

cargo install nb-fabric

Or download a prebuilt binary from Releases.

Prerequisites

• Azure CLI (az) installed and authenticated (az login)
• Access to a Microsoft Fabric workspace

Quick Start

# Check auth
nb auth status

# List notebooks
nb list "My Workspace"

# Create a Python notebook with a lakehouse attached
nb create "My Workspace/ETL Pipeline" --kernel python --lakehouse MainLH

# Add a cell
nb cell add "My Workspace/ETL Pipeline" --code "print('hello')"

# Execute interactively and see the output
nb exec "My Workspace/ETL Pipeline" --code "print('hello')" --lakehouse MainLH

# Run code directly against a lakehouse (no notebook needed)
nb exec -q "My Workspace/MainLH.Lakehouse" --code "print('hello')"
nb exec -q "My Workspace/MainLH.Lakehouse" --pyspark --code "spark.sql('SHOW TABLES').show()"

# Run as a batch job
nb job run "My Workspace/ETL Pipeline" --wait

Command Reference

Authentication

nb auth status                     Check Azure CLI authentication

Notebook CRUD

nb list <workspace>                List notebooks in a workspace
nb create <ws/name>                Create a new notebook
  --kernel python|pyspark            Kernel type (default: python)
  --lakehouse <name>                 Attach a lakehouse
  --warehouse <name>                 Attach a warehouse
nb export <ws/name> -o <path>      Export notebook to local .ipynb
nb open <ws/name>                  Open notebook in browser
nb delete <ws/name> --force        Delete a notebook

Cell Operations

nb cells <ws/name>                 List all cells (index, type, preview)
nb cell view <ws/name> <index>     View a single cell's source
nb cell add <ws/name>              Add a new cell
  --code <code>                      Cell content (required)
  --markdown                         Create markdown cell (default: code)
  --at <index>                       Insert at position (default: append)
nb cell edit <ws/name> <index>     Replace a cell's source
  --code <code>                      New content
nb cell rm <ws/name> <index>       Remove a cell

Execution

nb exec <ws/notebook>              Execute code via a notebook's attached lakehouse
  --code <code>                      Code to execute
  <cell-index>                       Or execute a specific cell by index
  --lakehouse <name>                 Lakehouse (auto-detected from notebook metadata)

nb exec -q <ws/lakehouse>          Quick ephemeral execution directly against a lakehouse
  --code <code>                      Code to execute (use --code - for stdin)
  --pyspark                          Use PySpark runtime (includes Spark context)
  --python                           Use Python runtime (default)

nb job run <ws/notebook>           Run notebook as batch job
  --wait                             Wait for completion
  --timeout <secs>                   Timeout in seconds (default: 3600)
nb job list <ws/notebook>          List recent job runs

Interactive execution auto-detects the kernel type from notebook metadata. Both modes return output directly to the terminal with structured metadata on stderr.

Quick Mode (exec -q)

Run Python or PySpark code against a lakehouse without creating a notebook. Sessions are created, used, and cleaned up automatically.

$ nb exec -q "My Workspace/MainLH.Lakehouse" --code "print(2+2)"
---- exec: Python ----
  Creating session...
  Waiting for idle...  (session a1b2c3d4)
  Session ready.
  Submitting code...
4
  Session cleaned up.
---- result ----
  session  a1b2c3d4-...
  runtime  Python
  duration 10.2s
  status   ok

Supports stdin piping for agents:

echo "spark.sql('SELECT count(*) FROM my_table').show()" | nb exec -q "WS/LH.Lakehouse" --pyspark --code -

Sessions

nb session <ws/notebook>           Show active sessions for a notebook

Scheduling

nb schedule list <ws/notebook>     List schedules
nb schedule create <ws/notebook>   Create a schedule
  --type Cron|Daily|Weekly           Schedule type (default: Cron)
  --interval <n>                     Interval (minutes for Cron)
  --start <datetime>                 Start time (ISO 8601)
  --end <datetime>                   End time (optional)
  --timezone <tz>                    Timezone (default: UTC)
  --enable                           Enable immediately
nb schedule update <ws/notebook> <id>  Update a schedule
  --enable true|false                Enable or disable
  --interval <n>                     New interval
nb schedule delete <ws/notebook> <id>  Delete a schedule

How It Works

nb authenticates via Azure CLI (az account get-access-token) using the same credentials as fab and az. It calls the Fabric REST API for notebook management and interactive execution.

Authentication

No service principal required. nb uses your Azure CLI session:

az login        # One-time; opens browser
nb auth status  # Verify

Notebook Formats

nb create generates notebooks with the correct Fabric metadata for either kernel:

Use or Re-use

You do not have the license to copy and incorporate this into your own products, trainings, courses, or tools. If you copy this project or use an agent to rewrite it, you must include attribution and a link to the original project.