Skip to main content

CLI tool for SiMa Developer Portal to download models, firmware, and apps.

Project description

sima-cli - SiMa Developer Portal CLI Tool

Python 3.8 Python 3.9 Python 3.10 Python 3.11 Python 3.12 Python 3.13 Python 3.14 E2E macOS E2E Windows E2E Ubuntu x86 E2E Ubuntu ARM64

sima-cli is the command-line interface for SiMa developer workflows. Use it to authenticate, set up SDK containers, update DevKits, install packages, download artifacts, and access Model Zoo and App Zoo content.

Documentation

The full command reference is generated as Markdown under docs/sima-cli.

Use the generated docs for detailed options, arguments, subcommands, and full help text:

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

Quick Start

sima-cli --help
sima-cli --version
sima-cli login

Use --internal or SIMA_CLI_INTERNAL=1 when internal Artifactory resources are required:

sima-cli --internal login
SIMA_CLI_INTERNAL=1 sima-cli install -v 2.1.2 tools/model-compiler/amd64

Common Workflows

Set up SDK containers:

sima-cli sdk setup
sima-cli sdk neat

Install Model Compiler from package metadata:

# amd64 host
sima-cli install -v 2.1.2 tools/model-compiler/amd64
# arm64 host
sima-cli install -v 2.1.2 tools/model-compiler/arm64

Download or install Neat artifacts:

sima-cli neat download core main
sima-cli install --neat core main

Update a DevKit:

sima-cli update -v 2.1.1 -y

Explore Model Zoo and App Zoo content:

sima-cli modelzoo list
sima-cli appzoo list

Top-Level Commands

Command Description Docs
sima-cli appzoo Access sample apps from the App Zoo. docs
sima-cli bootimg Prepare a bootable image for the SiMa DevKit. docs
sima-cli device Discover nearby SiMa.ai devices on the local network. docs
sima-cli download Download a file or folder from a URL. docs
sima-cli install Install SiMa packages from metadata. docs
sima-cli login Authenticate with the SiMa Developer Portal. docs
sima-cli logout Remove cached credentials and config files. docs
sima-cli mla Machine Learning Accelerator utilities. docs
sima-cli modelzoo Access models from the Model Zoo. docs
sima-cli neat Discover, download, and install Neat build artifacts. docs
sima-cli network Configure DevKit network settings. docs
sima-cli nvme Perform NVMe operations on the Modalix DevKit. docs
sima-cli packages Manage the local sima-cli package registry. docs
sima-cli playbooks Install and manage coding-agent playbooks. docs
sima-cli sdcard Prepare SD card storage. docs
sima-cli sdk Manage and launch SDK container environments. docs
sima-cli selfupdate Update sima-cli manually. docs
sima-cli serial Connect to the UART serial console of a DevKit. docs
sima-cli update Update a SiMa DevKit or remote device. docs

Development

Install development dependencies and run tests:

pip install -e ".[dev]"
python -m pytest tests/unit

Regenerate CLI documentation:

python scripts/generate_cli_markdown_docs.py

build.sh also regenerates the command docs before building the package.

Requirements

  • Python 3.8 or newer
  • Docker for SDK container workflows
  • DevKit connectivity for device update, serial, network, and boot-image workflows

For command-specific prerequisites, see the generated command reference.

Support

For issues and feature requests, use the sima-cli GitHub repository or contact the SiMa.ai development team.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sima_cli-2.1.13.tar.gz (307.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sima_cli-2.1.13-py3-none-any.whl (354.5 kB view details)

Uploaded Python 3

File details

Details for the file sima_cli-2.1.13.tar.gz.

File metadata

  • Download URL: sima_cli-2.1.13.tar.gz
  • Upload date:
  • Size: 307.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sima_cli-2.1.13.tar.gz
Algorithm Hash digest
SHA256 7a13d9aa4c9a228a5b28228e97443a965b7fc2a39f00948fb4b8796b94493e40
MD5 8869900d63821ede2b3f521cbd462c54
BLAKE2b-256 2300ee1c56ab44c95ce6dea626846a0fa681d044a3c6ce4a68ffed0f9a9218ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for sima_cli-2.1.13.tar.gz:

Publisher: publish-pypi.yml on sima-neat/sima-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sima_cli-2.1.13-py3-none-any.whl.

File metadata

  • Download URL: sima_cli-2.1.13-py3-none-any.whl
  • Upload date:
  • Size: 354.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sima_cli-2.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 cb3f7a4aa44738ebdf795a0065af01643f8d7364bb7a9ea425706d989f0c9887
MD5 253167c304d6f4f0bc8b32a7b15564b1
BLAKE2b-256 5e91d9756615f72dd4052bc8d1d0257cf9c65dfba49a7b905bce71c7f2f6d99c

See more details on using hashes here.

Provenance

The following attestation bundles were made for sima_cli-2.1.13-py3-none-any.whl:

Publisher: publish-pypi.yml on sima-neat/sima-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page