[ ~/netbox-sdk ]tty0

   _   _      _   ___           ___ ___  _  __
  | \ | |__ _| |_| _ )_____ __ / __|   \| |/ /
  |  \| / -_)  _| _ \/ _ \ \ / \__ \ |) | ' <
  |_|\_\___|\__|___/\___/_\_\ |___/___/|_|\_\
   c l i  ·  t u i  ·  s d k  ·  a s y n c

emerson@netdevops:~/netbox-sdk$ ./describe.sh netbox-sdk

Modern NetBox toolkit: an async SDK plus a CLI and a TUI for faster automation.

netbox-sdk is an SDK-first NetBox toolkit built on a single async runtime, exposing the same surface as a Python client, a Typer-powered CLI and a Textual-powered TUI.

It ships with a mock API for tests, GraphQL support, dynamic CLI commands and several Textual UIs for browsing and debugging your NetBox infrastructure.

netbox=4.6 / 4.5 / 4.4 / 4.3python=3.11+release=v0.0.8.post1

emerson@netdevops:~/netbox-sdk$ pip install 'netbox-sdk[all]'

emerson@netdevops:~/netbox-sdk$ nbx init

emerson@netdevops:~/netbox-sdk$ nbx dcim devices list

emerson@netdevops:~/netbox-sdk$ nbx tui

›overview

emerson@netdevops:~/netbox-sdk$ cat OVERVIEW.md

netbox-sdk is an SDK-first NetBox toolkit built on a single async runtime, exposing the same surface as a Python client, a Typer-powered CLI and a Textual-powered TUI.

It ships with a mock API for tests, GraphQL support, dynamic CLI commands and several Textual UIs for browsing and debugging your NetBox infrastructure.

›features

emerson@netdevops:~/netbox-sdk$ ./features --list

  • ├─Standalone async NetBox REST API SDK
  • ├─Typer-based command-line interface
  • ├─Textual-based terminal UI for interactive browsing
  • ├─Async REST client with token authentication
  • ├─Dynamic CLI commands with GraphQL support
  • ├─Built-in mock API with full CRUD for local testing
  • ├─Multiple Textual TUIs for browsing and debugging infra

›stack

emerson@netdevops:~/netbox-sdk$ cat stack.txt

  • › Python (async)
  • › Typer (CLI)
  • › Textual (TUI)
  • › Pydantic (validation)
  • › Material for MkDocs (docs)

›install

emerson@netdevops:~/netbox-sdk$ install

install
emerson@netdevops:~$ pip install 'netbox-sdk[all]'

# Pin a specific version: pip install 'netbox-sdk[all]==0.0.7.post6'

›repo

emerson@netdevops:~/netbox-sdk$ repo:stats

$ gh repo view emersonfelipesp/netbox-sdk --json
stars
14
forks
0
lang
Python
release
v0.0.8.post1

static · from public/github-data

›links

emerson@netdevops:~/netbox-sdk$ links