.. _sima_cli:

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``.

.. _SiMa Developer Portal: https://developer.sima.ai/signup

Installation
------------

.. tabs::

   .. tab:: On Linux, Mac and DevKit

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

      .. code-block:: bash

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


   .. tab:: On Windows 

      On Windows, install `Python <https://www.python.org/downloads/>`_ on your Windows machine before proceeding, then run the following command in the powershell window as Administrator. 

      .. code-block:: bash

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


.. note:: 

   In rare cases, certain features — such as :ref:`netboot` — require running ``sima-cli`` with elevated privileges using ``sudo``. In these situations, you must run ``sima-cli`` as the superuser:

   .. code-block:: bash

      sima-user@sima-user-machine:~$ sudo ~/.sima-cli/.venv/bin/sima-cli bootimg --boardtype modalix --fwtype elxr -v 2.0.0 --netboot

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**

.. code-block:: bash

   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 <https://huggingface.co/docs/hub/en/security-tokens>`_:

.. code-block:: bash

   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 <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic>`_ before proceeding.

.. code-block:: bash

   export GITHUB_TOKEN=<Your GitHub Personal Access Token>


View Commands
-------------

List all commands:

.. code-block:: bash

   sima-cli --help


View Command Help
-------------

List command options:

.. code-block:: bash

   sima-cli <command> --help

   Example: sima-cli install --help


Uninstall
---------

Remove ``sima-cli`` on the host:

.. code-block:: bash

   ~/.sima-cli/.venv/bin/pip uninstall sima-cli

Remove ``sima-cli`` on the DevKit:

.. code-block:: bash

   /data/.sima-cli/.venv/bin/pip uninstall sima-cli


Check Installed Version
-----------------------

Verify the installed version:

.. code-block:: bash

   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``.

Command Reference
-----------------
.. toctree::
   :maxdepth: 2
   :hidden:

   autodoc/sima-cli