.. _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 or DevKit 

      .. code-block:: bash

         python3 -m venv ~/.sima-cli-env
         source ~/.sima-cli-env/bin/activate
         pip3 install sima-cli

   .. tab:: On Windows 

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

      .. code-block:: bash

         python3 -m venv .sima-cli-env
         source .sima-cli-env\Script\activate.bat
         pip3 install sima-cli

   .. tab:: As sudo 

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

      .. code-block:: bash

         sudo pip3 install sima-cli

Authentication
--------------

To authenticate with the developer portal, run the following command:

.. code-block:: bash

   sima-cli login

The ``sima-cli install`` command allows generic package installation cross platforms. 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


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

List all commands:

.. code-block:: bash

   sima-cli --help

Uninstall
---------

Remove ``sima-cli``:

.. code-block:: bash

   pip3 uninstall sima-cli

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

Verify the installed version:

.. code-block:: bash

   sima-cli version