Skip to main content

Neat CLI

The installed library provides the neat environment command. Run it from either the SDK or DevKit to see installed component versions, installed sima-cli playbooks, and whether newer artifacts are available.

In the SDK, the status output also includes Insight host-port mappings from $HOME/.insight-config/neat-port-map.json.

Missing PyNeat or Insight installations do not prevent status reporting. If a version probe fails, the component shows unknown and neat writes the provider diagnostic to standard error. JSON output keeps the existing schema and reports unavailable versions as null.

Split installations report simaai-runner and simaai-scheduler. On the DevKit, versions come from the installed package database; in the SDK, they come from the cached DEB control metadata. Legacy neat-runtime and neat-gst-plugins rows remain visible when those packages are present or no split component is detected. JSON adds components.runner and components.scheduler while preserving the legacy runtime and gstPlugins keys; absent versions remain null.

sdk or devkit$neat

Example output from a legacy installation:

Neat Environment
  Mode               Palette SDK
  Sysroot            /opt/toolchain/aarch64/modalix
  Update check       online

Components
  Neat core              0.6.1 channel=release latest=0.6.1
  PyNeat                 0.6.1
  neat-runtime           0.6.1
  neat-gst-plugins       0.6.1
  neat-insight           0.0.9 channel=release status=Running venv=/opt/neat-insight/venv
  Model Compiler         3.0.0.1 run activate-model-compiler to activate

Exposed Ports
  Insight Web UI     https://10.0.0.22:9900

  Name               Protocol Host Port (Start) Host Port (End)
  ------------------ -------- ----------------- ---------------
  mainUI             tcp      9900              -
  metadataUDP        udp      9100              9179
  rtsp.tcp           tcp      8554              -
  videoUDP           udp      9000              9079
  videoUI            tcp      8081              -
  webRTC             udp      40000             40199
  webSSH             tcp      8022              -

JSON Output​

For automation and tool integrations, use JSON output:

sdk or devkit$neat --json

Update Installed Components​

To update the Neat Library runtime, neat-insight, and installed sima-cli playbooks from the detected channel, run:

sdk or devkit$neat update

To update only the Neat Library runtime, without inspecting or updating Insight or playbooks, run:

sdk or devkit$neat update --core-only

Next Step​

Continue to Compile a Model to prepare a model for Modalix — this runs in the SDK and needs no DevKit. To run a full application on hardware, see Hello Neat!, which requires a paired DevKit.

PCIe host and card status​

The sima-pcie-host package also installs neat on Ubuntu. Run neat or neat --json to read installed host packages, PyNeatPCIe, and the board and installed software on each SiMa PCIe card. Cards are listed by PCI address and interface. A PCI address describes the current attachment, not a permanent board serial number.

neat
neat --json
neat --offline

Card queries use the provisioned 10.0.N.1 host interface and 10.0.N.2 card address, matching pcie-setup.sh. Configure network access and trusted SSH keys first. The command does not configure interfaces, enroll host keys, prompt for passwords, use sudo on cards, or modify packages. Missing interfaces, nonstandard addresses, SSH failures, and unavailable software are reported per card; reachable cards still report their versions.

NEAT_PCIE_SSH_USER selects the card SSH user (default sima). NEAT_PCIE_SSH_KEY selects a private key (default ~/.ssh/sima_neat_pcie_ed25519); existing SSH configuration and agent authentication remain available. --offline skips Internet update checks but still reads attached cards over local SSH. PCIe host status skips artifact update checks; use sima-cli neat install core/pciehost/<distro>/<arch>@<ref> to update the host package. neat update does not update PCIe cards.

JSON retains sima.neat.status.v1 and adds components.pcieHost, components.pcieScheduler, components.pyneatpcie, and pcie. The pcie object contains host software, a cards array with PCI address, interfaces, address, state, software and error fields, and topology errors. Missing remote software is null, not an inferred installed version.

PyNeat and PyNeatPCIe status lists each detected installation with its version and virtual environment path. Separate environments are reported as multiple environments, not a version conflict. For packages outside a virtual environment, the output shows the package directory instead. Status reads package metadata without importing native modules.

Each Python entry in JSON adds an installations array. Each record contains version, environment, and path (the package directory). environment is null outside a virtual environment. The summary version is null when installed versions differ; multiple installations alone do not set error. Symlinked paths to the same installation are listed once.