sima-cli Command Reference
Generated Markdown reference documentation for the sima-cli command line interface.
Installation
For most users, install the latest official release from the public installer URL for your operating system.
Linux, macOS, and DevKit
Run the installer from a terminal:
curl -fsSL https://artifacts.neat.sima.ai/sima-cli/linux-mac.sh | bash
After installation, open a new terminal or reload your shell profile, then verify the install:
sima-cli --version
Windows PowerShell
Download and run the Windows installer from PowerShell:
Invoke-WebRequest https://artifacts.neat.sima.ai/sima-cli/windows.bat -OutFile windows.bat
.\windows.bat
After installation, open a new Command Prompt or PowerShell window, then verify the install:
sima-cli --version
Advanced: choose a branch or release
Use install.py only when you need to choose a specific tested branch build or release instead of installing the latest official PyPI release.
On Linux, macOS, or DevKit:
curl -fsSL https://artifacts.neat.sima.ai/sima-cli/install.py -o sima-cli-install.py
python3 sima-cli-install.py
Install a specific branch or release:
python3 sima-cli-install.py feature/my-branch latest
python3 sima-cli-install.py v2.1.6 latest
On Windows PowerShell:
Invoke-WebRequest https://artifacts.neat.sima.ai/sima-cli/install.py -OutFile sima-cli-install.py
python .\sima-cli-install.py
To install a specific branch or release:
python .\sima-cli-install.py feature/my-branch latest
python .\sima-cli-install.py v2.1.6 latest
Release tags such as v2.1.6 install from public PyPI. Branch names install tested artifacts from artifacts.neat.sima.ai/sima-cli.
Public PyPI releases can also be installed directly:
pip install sima-cli
Guides
| Guide | Description |
|---|---|
| Boot Image and Netboot Operations | Prepare local or downloaded images, configure remote netboot safely, recover from address changes, and prepare eMMC for flashing with sima-cli bootimg. |
| SDK Setup and Extension Management | Choose optional SDK services, browser VS Code extensions, and the Model Compiler installation source when running sima-cli sdk setup. |
| System Update Operations | Use daily builds, signed eLxr 3.0 SWU bundles, A/B inspection, storage staging, and persistent-overlay handling with sima-cli update. |
| Neat SDK Networking Setup | The Neat SDK, also known as the Neat Development Environment, runs inside a Docker container. sima-cli sdk setup creates the container, prepares the host workspace mount, starts Insight when enabled, and publishes the container ports that the host browser and a DevKit use during development. |
| Roll Back SDK Network Changes | Use rollback when you want to inspect or undo Linux host networking changes made by SDK setup or network repair. |
| Troubleshoot SDK Networking | Use the network doctor when the SDK container, Insight UI, DevKit SSH, RTSP, WebRTC video, or workspace sync does not behave as expected. |
Top-Level Commands
| Command | Description |
|---|---|
sima-cli appzoo | Access sample apps from the App Zoo. |
sima-cli bootimg | Prepare a bootable image for the SiMa DevKit. |
sima-cli device | Discover nearby SiMa.ai devices on the local network. |
sima-cli download | Download a file or a whole folder from a given URL. |
sima-cli install | Install SiMa packages. |
sima-cli login | Authenticate with the SiMa Developer Portal. |
sima-cli logout | Log out by deleting cached credentials and config files. |
sima-cli mla | Machine Learning Accelerator Utilities. |
sima-cli modelzoo | Access models from the Model Zoo. |
sima-cli neat | Discover, download, and install Neat build artifacts. |
sima-cli network | Setup Network IP address on the DevKit |
sima-cli nvme | Perform NVMe operations on the Modalix DevKit. |
sima-cli packages | Manage sima-cli package registry (list, inspect, clean, etc.) |
sima-cli playbooks | Install and manage playbooks (Codex/Claude). |
sima-cli sdcard | Prepare the SD Card as a data storage device for MLSoc DevKit or Modalix Early Access Unit |
sima-cli sdk | Manage and launch SiMa SDK 2.0 container environments (Beta). |
sima-cli selfupdate | Update sima-cli manually from PyPI or a direct wheel URL. |
sima-cli serial | Connect to the UART serial console of the DevKit. |
sima-cli update | Update a SiMa DevKit, remote device, or Linux PCIe host. |
Complete Command List
sima-clisima-cli appzoosima-cli bootimgsima-cli devicesima-cli downloadsima-cli installsima-cli loginsima-cli logoutsima-cli mlasima-cli modelzoosima-cli neatsima-cli networksima-cli nvmesima-cli packagessima-cli playbookssima-cli sdcardsima-cli sdksima-cli selfupdatesima-cli serialsima-cli updatesima-cli appzoo clonesima-cli appzoo describesima-cli appzoo getsima-cli appzoo listsima-cli device discoversima-cli mla meminfosima-cli modelzoo describesima-cli modelzoo getsima-cli modelzoo listsima-cli neat artifactssima-cli neat downloadsima-cli neat installsima-cli neat sdksima-cli packages buildsima-cli packages listsima-cli packages showsima-cli playbooks applysima-cli playbooks deletesima-cli playbooks describesima-cli playbooks installsima-cli playbooks listsima-cli playbooks removesima-cli playbooks updatesima-cli sdk doctorsima-cli sdk elxrsima-cli sdk lssima-cli sdk modelsima-cli sdk mpksima-cli sdk neatsima-cli sdk networksima-cli sdk removesima-cli sdk ros2sima-cli sdk runsima-cli sdk setupsima-cli sdk startsima-cli sdk stopsima-cli sdk yoctosima-cli sdk doctor networksima-cli sdk network repairsima-cli sdk network rollback