netbox-super-cli 1.4.0__tar.gz → 1.6.0__tar.gz

netbox_super_cli-1.6.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,127 @@
+name: 🐞 Bug report
+description: Something in nsc (the CLI or TUI) behaves incorrectly or crashes.
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for filing a bug! The version numbers and the **exact command** make
+        most issues reproducible — please fill in as much as you can.
+
+        > [!WARNING]
+        > **Redact secrets.** Never paste your `NSC_TOKEN`, API tokens, or any
+        > credential. Replace them with `***`.
+
+  - type: input
+    id: nsc-version
+    attributes:
+      label: nsc version
+      description: Output of `nsc --version`.
+      placeholder: "nsc 1.4.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: install-method
+    attributes:
+      label: How did you install nsc?
+      options:
+        - uv tool install
+        - pipx
+        - pip
+        - uvx (ephemeral)
+        - from source / git checkout
+        - other
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python version
+      description: Output of `python --version` for the interpreter nsc runs under.
+      placeholder: "3.12.x"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating system
+      options:
+        - Linux
+        - macOS
+        - Windows
+        - Other
+    validations:
+      required: true
+
+  - type: input
+    id: netbox-version
+    attributes:
+      label: NetBox version
+      description: The NetBox server version nsc talks to (NetBox UI footer, or `/api/status/`).
+      placeholder: "v4.6.3"
+    validations:
+      required: false
+
+  - type: dropdown
+    id: schema-source
+    attributes:
+      label: Which schema was nsc using?
+      description: nsc generates commands from the OpenAPI schema — a live fetch, the on-disk cache, or the bundled offline snapshot.
+      options:
+        - Live NetBox API
+        - Cached schema
+        - Bundled offline snapshot
+        - Not sure
+    validations:
+      required: false
+
+  - type: textarea
+    id: command
+    attributes:
+      label: Command you ran
+      description: The exact `nsc ...` invocation. Redact tokens.
+      render: shell
+      placeholder: nsc dcim devices list --site-id 42 --output json
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: The actual behavior, including any error message or traceback.
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant logs / audit output
+      description: Optional. Anything else that helps — re-run with extra output if useful. Redact secrets first.
+      render: shell
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Before submitting
+      options:
+        - label: I searched existing issues and this isn't a duplicate.
+          required: true
+        - label: I'm on the latest release of nsc, or I noted my version above.
+          required: true
+        - label: I removed any tokens / credentials from the command and logs above.
+          required: true

netbox_super_cli-1.6.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📖 Documentation
+    url: https://thomaschristory.github.io/netbox-super-cli/
+    about: Guides, the CLI/TUI reference, and configuration docs — please check here first.
+  - name: 💬 Questions & usage help
+    url: https://github.com/thomaschristory/netbox-super-cli/discussions
+    about: Ask how-to questions, share setups, or propose ideas before filing a feature request.
+  - name: 🔐 Security vulnerability
+    url: https://github.com/thomaschristory/netbox-super-cli/security/advisories/new
+    about: Report a security issue privately. Please do NOT open a public issue for vulnerabilities.

netbox_super_cli-1.6.0/.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,35 @@
+name: 📖 Documentation issue
+description: A gap, error, or confusing part of the docs, README, or bundled SKILL.
+title: "[Docs]: "
+labels: ["documentation"]
+body:
+  - type: textarea
+    id: where
+    attributes:
+      label: Where is the problem?
+      description: A page URL, a file path (e.g. `README.md`, `docs/...`), or a command's `--help` output.
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What's wrong or missing?
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested fix
+      description: Optional — a sentence, a corrected snippet, or a link to the right info.
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Before submitting
+      options:
+        - label: I searched existing issues and this isn't a duplicate.
+          required: true

netbox_super_cli-1.6.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,68 @@
+name: ✨ Feature request
+description: Suggest a new capability or improvement for the CLI, TUI, or output.
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for the idea! Describing the **problem** first (not just the
+        solution) helps us find the best fit. nsc is generated from NetBox's
+        OpenAPI schema, so features usually apply across every resource.
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: Which area?
+      options:
+        - CLI (commands, flags, output)
+        - TUI (interactive browser)
+        - Output / formatting (table, json, jsonl, yaml, csv)
+        - Config / auth / profiles
+        - Shell completion
+        - Schema / code generation
+        - Documentation
+        - Other / not sure
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem are you trying to solve?
+      description: What are you trying to do, and where does nsc get in the way today?
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: What would you like nsc to do? A sketch of the command, flag, or UX is great.
+    validations:
+      required: false
+
+  - type: textarea
+    id: example
+    attributes:
+      label: Example usage
+      description: How would it look on the command line (or in the TUI)?
+      render: shell
+      placeholder: nsc dcim devices list --some-new-flag
+    validations:
+      required: false
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Before submitting
+      options:
+        - label: I searched existing issues and this isn't a duplicate.
+          required: true

netbox_super_cli-1.6.0/.github/pull_request_template.md

@@ -0,0 +1,17 @@
+<!--
+Thanks for contributing to netbox-super-cli! Keep this short — a couple of
+sentences plus the checklist is plenty. See CLAUDE.md / docs/contributing for
+conventions.
+-->
+
+## What & why
+
+<!-- What does this change, and why? Link the issue: Closes #123 -->
+
+## Checklist
+
+- [ ] PR title follows [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `docs:`, `chore:`, `refactor:`, …)
+- [ ] Tests added or updated, and `just test` passes
+- [ ] `just lint` passes (ruff + `mypy --strict`)
+- [ ] Docs / `CHANGELOG.md` updated if this is user-facing
+- [ ] Linked the related issue (e.g. `Closes #…`)

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/.github/workflows/test.yml

@@ -10,12 +10,11 @@ permissions:
 
 jobs:
   test:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-latest]
-        python: ["3.12", "3.13"]
+        python: ["3.12", "3.13", "3.14"]
     steps:
       - uses: actions/checkout@v7
       - name: Install uv

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/CHANGELOG.md

@@ -2,6 +2,60 @@
 
 All notable changes to netbox-super-cli are tracked here. Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) loosely. From v1.0.0 onward, releases follow [Semantic Versioning](https://semver.org/) and the version in `pyproject.toml` matches the git tag. Pre-1.0 milestones (Phase 1-5) were pinned by tag while `pyproject.toml` stayed at `0.0.1`.
 
+## v1.6.0 — 2026-06-29
+
+Minor release. The interactive TUI gets human-readable custom-field columns,
+clean rendering of list/M2M fields, and a far richer bulk-edit form.
+
+### Added
+
+- **Custom-field column labels** ([#132]). Custom-field columns now show the
+  field's human label (e.g. "Site Contact") instead of the raw
+  `custom_fields.<name>` key — in the TUI list headers and column chooser, and in
+  CLI `table`/`csv` output for `list`, `get`, and create/update responses. The
+  raw `custom_fields.<name>` key stays the selector, so `--columns` and saved
+  column prefs are unchanged. Labels come from the custom-field definitions
+  (`/api/extras/custom-fields/`, scoped to the resource's object type) and fall
+  back to a humanized name or the raw key when unavailable or ambiguous; JSON/YAML
+  output is untouched.
+- **Bulk-edit: per-field custom fields and a tags dropdown** ([#134]). The TUI
+  bulk-edit form now expands `custom_fields` into one typed widget per field
+  (text/number/switch/select/multi-select), each with its own include toggle, and
+  renders `tags` as a multi-select populated from `/api/extras/tags/` (submitting
+  the NetBox-native `{name, slug}` list). The same per-field custom fields and
+  tag picker apply to single-record editing, and the bulk form's layout is
+  aligned with the single-edit experience. Falls back to plain inputs when the
+  definitions can't be fetched.
+
+### Fixed
+
+- **Detail view rendered list fields as raw dicts** ([#133]). Tags and other
+  list-of-object fields in the record detail view showed a raw
+  `[{'id': …, 'display': …}]` repr; they now render as a clean comma-joined list
+  (colored when object colors are on), matching the list table.
+
+[#132]: https://github.com/thomaschristory/netbox-super-cli/issues/132
+[#133]: https://github.com/thomaschristory/netbox-super-cli/issues/133
+[#134]: https://github.com/thomaschristory/netbox-super-cli/issues/134
+
+## v1.5.0 — 2026-06-29
+
+Minor release. Saved searches become interchangeable with the NetBox web UI.
+
+### Changed
+
+- **Saved searches are now NetBox-native** ([#129]). Filter sets saved from the
+  TUI (`Ctrl+W`) and applied via `--saved` are stored as NetBox saved filters
+  (`extras.saved-filters`), scoped to the resource's object type, so they are
+  fully interchangeable with the web UI's filter dropdown — a search saved in
+  `nsc` appears in the web UI and vice versa. The object type is resolved from
+  NetBox's own object-type registry (`/api/core/object-types/`), so the mapping
+  is exact rather than guessed. When NetBox is unreachable or the user lacks
+  permission on `extras.savedfilter`, saves/loads transparently fall back to the
+  previous local `config.yaml` store and surface a notice instead of failing.
+
+[#129]: https://github.com/thomaschristory/netbox-super-cli/issues/129
+
 ## v1.4.0 — 2026-06-26
 
 Minor release. Three user-facing features for the interactive TUI and table

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/PKG-INFO

@@ -1,19 +1,25 @@
 Metadata-Version: 2.4
 Name: netbox-super-cli
-Version: 1.4.0
+Version: 1.6.0
 Summary: Dynamic NetBox CLI generated from the live OpenAPI schema.
 Project-URL: Homepage, https://github.com/thomaschristory/netbox-super-cli
+Project-URL: Documentation, https://thomaschristory.github.io/netbox-super-cli/
+Project-URL: Source, https://github.com/thomaschristory/netbox-super-cli
 Project-URL: Issues, https://github.com/thomaschristory/netbox-super-cli/issues
-Author-email: Thomas <mick27@gmail.com>
+Project-URL: Changelog, https://github.com/thomaschristory/netbox-super-cli/blob/main/CHANGELOG.md
+Author: Thomas Christory
 License-Expression: Apache-2.0
 License-File: LICENSE
 Keywords: automation,cli,netbox,openapi
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
+Classifier: Intended Audience :: Information Technology
 Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: System :: Networking
 Requires-Python: >=3.12
 Requires-Dist: click>=8.1
@@ -114,9 +120,12 @@ uv run nsc ipam prefixes list --filter created__gte=2026-01-01 --output yaml
 
 ### Saved searches
 
-Filter sets you save from the TUI (Ctrl+W in the filter builder) are stored
-locally under `saved_searches` in `~/.nsc/config.yaml`, keyed by tag/resource.
-Re-apply one on the CLI with `--saved`:
+Filter sets you save from the TUI (Ctrl+W in the filter builder) are stored as
+**NetBox native saved filters** (`extras.saved-filters`), scoped to the resource's
+object type. A search you save in `nsc` shows up in the NetBox web UI's filter
+dropdown for that object — and a filter saved in the web UI loads in the TUI
+(Ctrl+O) — so the two are fully interchangeable. Re-apply one on the CLI with
+`--saved`:
 
 ```sh
 uv run nsc dcim devices list --saved active-switches
@@ -124,9 +133,10 @@ uv run nsc dcim devices list --saved active-switches
 uv run nsc dcim devices list --saved active-switches --status offline
 ```
 
-This is a local, per-config convenience and is unrelated to NetBox's
-server-side saved filters (`extras saved-filters`), which store web-UI query
-strings.
+When NetBox is unreachable (offline, or missing permission on
+`extras.savedfilter`), `nsc` transparently falls back to a local store under
+`saved_searches` in `~/.nsc/config.yaml`, keyed by tag/resource, and tells you it
+did so.
 
 ### Object colors
 

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/README.md

@@ -85,9 +85,12 @@ uv run nsc ipam prefixes list --filter created__gte=2026-01-01 --output yaml
 
 ### Saved searches
 
-Filter sets you save from the TUI (Ctrl+W in the filter builder) are stored
-locally under `saved_searches` in `~/.nsc/config.yaml`, keyed by tag/resource.
-Re-apply one on the CLI with `--saved`:
+Filter sets you save from the TUI (Ctrl+W in the filter builder) are stored as
+**NetBox native saved filters** (`extras.saved-filters`), scoped to the resource's
+object type. A search you save in `nsc` shows up in the NetBox web UI's filter
+dropdown for that object — and a filter saved in the web UI loads in the TUI
+(Ctrl+O) — so the two are fully interchangeable. Re-apply one on the CLI with
+`--saved`:
 
 ```sh
 uv run nsc dcim devices list --saved active-switches
@@ -95,9 +98,10 @@ uv run nsc dcim devices list --saved active-switches
 uv run nsc dcim devices list --saved active-switches --status offline
 ```
 
-This is a local, per-config convenience and is unrelated to NetBox's
-server-side saved filters (`extras saved-filters`), which store web-UI query
-strings.
+When NetBox is unreachable (offline, or missing permission on
+`extras.savedfilter`), `nsc` transparently falls back to a local store under
+`saved_searches` in `~/.nsc/config.yaml`, keyed by tag/resource, and tells you it
+did so.
 
 ### Object colors
 

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/docs/guides/interactive-tui.md

@@ -81,11 +81,27 @@ NetBox list endpoint exposes hundreds of query parameters.
 | <kbd>↓</kbd> | Move to the next field (from a text field) |
 | <kbd>Tab</kbd> / <kbd>Shift</kbd>+<kbd>Tab</kbd> | Move between fields |
 | <kbd>Ctrl</kbd>+<kbd>S</kbd> | Apply |
+| <kbd>Ctrl</kbd>+<kbd>W</kbd> | Save the current filters as a named search |
+| <kbd>Ctrl</kbd>+<kbd>O</kbd> | Load (or delete) a saved search |
 | <kbd>Esc</kbd> | Cancel |
 
 Applying re-queries the list. Reopening the builder shows your current filters
 so you can refine them.
 
+### Saved searches
+
+<kbd>Ctrl</kbd>+<kbd>W</kbd> stores the current filter set as a NetBox **native
+saved filter** (`extras.saved-filters`), scoped to the current resource's object
+type. It then appears in the NetBox web UI's filter dropdown for that object, and
+filters created in the web UI load here with <kbd>Ctrl</kbd>+<kbd>O</kbd> — the two
+surfaces are interchangeable. In the load picker, <kbd>Enter</kbd> applies the
+highlighted search and <kbd>d</kbd> deletes it. Re-apply one non-interactively
+with `nsc <app> <resource> list --saved <name>`.
+
+If NetBox is unreachable (offline, or you lack permission on
+`extras.savedfilter`), saves and loads transparently fall back to a local store in
+`~/.nsc/config.yaml` and a toast tells you the fallback was used.
+
 ## Viewing and editing a record
 
 The detail view **is** the edit surface — there is no separate "edit window".

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/nsc/_version.py

@@ -1,3 +1,3 @@
 """Single source of truth for the package version."""
 
-__version__ = "1.4.0"
+__version__ = "1.6.0"

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/nsc/cli/handlers.py

@@ -66,6 +66,33 @@ def _out(stream: TextIO | None) -> TextIO:
     return stream if stream is not None else sys.stdout
 
 
+def _custom_field_header_labels(
+    ctx: RuntimeContext, operation: Operation, columns: list[str] | None
+) -> dict[str, str] | None:
+    """Map ``custom_fields.<name>`` columns to their NetBox labels, or None.
+
+    Only fetches definitions when a custom-field column is actually selected, so
+    ordinary lists incur no extra request. Display-only: the raw key stays the
+    selector everywhere else.
+    """
+    if not columns or not any(c.startswith("custom_fields.") for c in columns):
+        return None
+    from nsc.savedfilters.custom_fields import (  # noqa: PLC0415
+        CustomFieldResolver,
+        custom_field_labels,
+    )
+
+    # Custom-field definitions are keyed by the collection (list) endpoint, so a
+    # detail path like /api/dcim/devices/{id}/ must reduce to /api/dcim/devices/.
+    list_path = operation.path
+    if list_path.endswith("{id}/"):
+        list_path = list_path[: -len("{id}/")]
+    defs = CustomFieldResolver(ctx.client).resolve(list_path)
+    if defs is None:
+        return None
+    return custom_field_labels(columns, defs)
+
+
 def parse_filters(raw: list[str]) -> dict[str, str]:
     out: dict[str, str] = {}
     for item in raw:
@@ -97,10 +124,12 @@ def handle_list(
                 page_size=ctx.page_size,
             )
         )
+        columns = ctx.resolve_columns(op_tag, op_resource, operation)
         render(
             rows,
             format=ctx.output_format,
-            columns=ctx.resolve_columns(op_tag, op_resource, operation),
+            columns=columns,
+            header_labels=_custom_field_header_labels(ctx, operation, columns),
             stream=_out(stream),
             compact=ctx.compact,
             color=ctx.color,
@@ -124,10 +153,12 @@ def handle_get(
     try:
         params, path_vars = _split_params(operation, kwargs)
         obj = ctx.client.get(operation.path.format(**path_vars), params)
+        columns = ctx.resolve_columns(op_tag, op_resource, operation)
         render(
             obj,
             format=ctx.output_format,
-            columns=ctx.resolve_columns(op_tag, op_resource, operation),
+            columns=columns,
+            header_labels=_custom_field_header_labels(ctx, operation, columns),
             stream=_out(stream),
             compact=ctx.compact,
             color=ctx.color,
@@ -611,10 +642,12 @@ def _render_response(
     if is_delete:
         _render_delete_ok(ctx, stream=stream)
         return
+    columns = ctx.resolve_columns(op_tag, op_resource, operation)
     render(
         response,
         format=ctx.output_format,
-        columns=ctx.resolve_columns(op_tag, op_resource, operation),
+        columns=columns,
+        header_labels=_custom_field_header_labels(ctx, operation, columns),
         stream=stream,
         compact=ctx.compact,
         color=ctx.color,

{netbox_super_cli-1.4.0 → netbox_super_cli-1.6.0}/nsc/cli/registration.py

@@ -128,22 +128,33 @@ def _resolve_saved_filters(
     ctx: RuntimeContext,
     tag_name: str,
     resource_name: str,
+    list_path: str,
     saved_name: str | None,
     explicit_filters: list[tuple[str, str]],
     typed_kwargs: dict[str, Any],
 ) -> list[tuple[str, str]]:
     """Layer a `--saved` filter set under explicit `--filter` and typed options.
 
-    Saved params are the base; explicit `--filter` pairs and any non-None typed
-    query option (already in ``typed_kwargs``) win. Order matters: ``handle_list``
-    overlays ``ctx.filters`` onto the typed-option params, so saved keys that the
-    user also set via a typed flag must be dropped here to let the flag win.
+    The set is resolved against NetBox's native saved filters (interchangeable
+    with the web UI), falling back to the local `config.yaml` map when the API is
+    unavailable. Saved params are the base; explicit `--filter` pairs and any
+    non-None typed query option (already in ``typed_kwargs``) win. Order matters:
+    ``handle_list`` overlays ``ctx.filters`` onto the typed-option params, so
+    saved keys that the user also set via a typed flag must be dropped here to let
+    the flag win.
     """
     if saved_name is None:
         return explicit_filters
-    from nsc.config.saved_searches import get_saved_search  # noqa: PLC0415
+    from nsc.config.saved_searches import ConfigFileSavedSearchStore  # noqa: PLC0415
+    from nsc.savedfilters.store import NativeSavedFilterStore  # noqa: PLC0415
 
-    saved = get_saved_search(ctx.config, tag_name, resource_name, saved_name)
+    store = NativeSavedFilterStore(
+        ctx.client,
+        ConfigFileSavedSearchStore(ctx.config),
+        on_error=lambda message: typer.echo(f"Warning: {message}", err=True),
+    )
+    available = store.list(list_path, tag_name, resource_name)
+    saved = available.get(saved_name)
     if saved is None:
         raise typer.BadParameter(
             f"no saved search named {saved_name!r} for {tag_name}/{resource_name}"
@@ -191,7 +202,7 @@ def _build_read_closure(
             "limit": limit,
             "fetch_all": fetch_all,
             "filters": _resolve_saved_filters(
-                ctx, tag_name, resource_name, saved_name, explicit_filters, kwargs
+                ctx, tag_name, resource_name, operation.path, saved_name, explicit_filters, kwargs
             ),
         }
         if output:
@@ -350,9 +361,10 @@ def _build_global_flag_params() -> tuple[inspect.Parameter, ...]:
                 None,
                 "--saved",
                 help=(
-                    "Apply a LOCAL named filter set saved from the TUI (config "
-                    "`saved_searches`). Explicit --filter/typed options override it. "
-                    "Unrelated to NetBox server-side saved filters."
+                    "Apply a named saved filter for this resource. Resolves against "
+                    "NetBox's native saved filters (interchangeable with the web UI), "
+                    "falling back to the local config `saved_searches` when the API is "
+                    "unavailable. Explicit --filter/typed options override it."
                 ),
             ),
         ),