sima-cli

sima-cli is a lightweight CLI tool for streamlined asset retrieval and SiMa DevKit updates. It installs on macOS, Windows, Linux, and the SiMa DevKit via pip3 install sima-cli. Users must register and be approved at the SiMa Developer Portal to access digital assets, then authenticate with sima-cli login.

Installation

On Linux, Mac and DevKit run the following command to install sima-cli

devkit:~$ curl https://docs.sima.ai/_static/tools/sima-cli-installer.sh | bash

On Windows, make sure you opened the CMD window as Administrator.

C:\Users\sima> iwr https://docs.sima.ai/_static/tools/sima-cli-install.bat -useb -outfile install.bat; cmd /c install.bat

In rare cases, certain features — such as Update with Net Boot — require running sima-cli with elevated privileges using sudo. In these situations, you must install sima-cli as the superuser:

sima-user@sima-user-machine:~$ sudo pip3 install sima-cli

Authentication

The sima-cli install command allows generic package installation cross platforms. This may require the user to authenticate before sima-cli can proceed to downloading the assets.

SiMa.ai Developer Portal Authentication

sima-cli login

Hugging Face Authentication

If the package you are installing includes private assets hosted on Hugging Face, you must first authenticate using your Hugging Face user token:

huggingface-cli login

GitHub Authentication

If the package you are installing depends on private GitHub repositories, you must set the GITHUB_TOKEN environment variable with a valid classic GitHub Personal Access Token before proceeding.

export GITHUB_TOKEN=<Your GitHub Personal Access Token>

View Commands

List all commands:

sima-cli --help

View Command Help

List command options:

sima-cli <command> --help

Example: sima-cli install --help

Uninstall

Remove sima-cli:

pip3 uninstall sima-cli

Check Installed Version

Verify the installed version:

sima-cli version

Update sima-cli

By default, when sima-cli runs with an active Internet connection, it checks for updates and prompts the user if a new version is available. To disable this behavior, set the SIMA_CLI_CHECK_FOR_UPDATE environment variable to 0.