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. It handles authentication, SDK container setup, DevKit updates, package installation, artifact downloads, Model Zoo/App Zoo access, and related development utilities.

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

Install the latest main build:

curl -fsSL https://artifacts.sima-neat.com/tools/sima-cli-install.py -o sima-cli-install.py
python3 sima-cli-install.py main latest

Install interactively:

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.sima-neat.com/tools/sima-cli-install.py -OutFile sima-cli-install.py
python .\sima-cli-install.py main latest

Public PyPI releases can also be installed directly:

pip install sima-cli

Quick Start

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

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.1 sdk-extensions/model

Common Workflows

Set up SDK containers:

sima-cli sdk setup
sima-cli sdk neat

Install a package from metadata:

sima-cli install -v 2.1.1 sdk-extensions/model

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
sima-cli version Show the installed CLI version. 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.10.tar.gz (269.7 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.10-py3-none-any.whl (312.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sima_cli-2.1.10.tar.gz
  • Upload date:
  • Size: 269.7 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.10.tar.gz
Algorithm Hash digest
SHA256 930fe4cdc72ec8f2c3dda2ae823f78b2860e72db2dc9ac1025136296a0064dc7
MD5 6a8dbd1658acd286492822ae4926e6ad
BLAKE2b-256 510a15a128a74203f7fca98820c5c177eb4751cc50848ee83b09ad0f0b2f58d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for sima_cli-2.1.10.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.10-py3-none-any.whl.

File metadata

  • Download URL: sima_cli-2.1.10-py3-none-any.whl
  • Upload date:
  • Size: 312.0 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f0ecca8f01452231cc24d521bc7558b242f5c8ad9f0f74c7e1a05072e32f3689
MD5 1c59886b882dc4f7c6e638d6d62da138
BLAKE2b-256 a113db6d32be6303b6be75b0e2fdbccddaea9d0bfd27668119ca398c28264a94

See more details on using hashes here.

Provenance

The following attestation bundles were made for sima_cli-2.1.10-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