netbox-sdk 0.0.5

API-first NetBox CLI + Textual TUI

netbox-sdk

netbox-sdk is a terminal client and SDK for NetBox with two interfaces built on one core runtime:

• netbox_cli — Typer command-line interface
• netbox_tui — Textual terminal applications
• netbox_sdk — standalone REST API SDK shared by both

Published package names remain:

• netbox-sdk
• netbox-console

Quick Start with the Demo Instance

Install:

pip install 'netbox-sdk[all]'

Authenticate against the public demo instance:

nbx demo init

Try a few commands:

nbx demo dcim devices list
nbx demo ipam prefixes list
nbx demo tui
nbx demo dev tui

Install

Minimal SDK only:

pip install netbox-sdk

CLI:

pip install 'netbox-sdk[cli]'

TUI:

pip install 'netbox-sdk[tui]'

Everything:

pip install 'netbox-sdk[all]'

With uv as a user tool:

uv tool install --force 'netbox-sdk[cli]'

Developer checkout:

git clone https://github.com/emersonfelipesp/netbox-sdk.git
cd netbox-sdk
uv sync --dev --extra cli --extra tui --extra demo
uv run nbx --help

Common Commands

nbx init
nbx dcim devices list
nbx dcim devices get --id 1
nbx tui
nbx dev tui
nbx logs

Architecture

• netbox_sdk owns config, auth, caching, schema parsing, request resolution, shared formatting, and demo helpers.
• netbox_cli owns the nbx command tree and lazy-loads netbox_tui where needed.
• netbox_tui owns all Textual apps, themes, widgets, and TCSS.

Contributor Workflow

uv sync --dev --extra cli --extra tui --extra demo
uv run pre-commit install --hook-type pre-commit --hook-type pre-push
uv run pre-commit run --all-files
uv run pytest