AtomShields Cli

AtomShields Cli est une interface en ligne de commande pour utiliser le logiciel AtomShields <https://github.com/ElevenPaths/AtomShields>_

.. raw:: html

Installation

.. code-block:: shell

pip install atomshieldscli

Utilisation de base

.. code-block:: shell

ascli --target --name <project_name>

Les valeurs action autorisées sont :

• install : Pour installer un vérificateur (checker) ou un rapport, selon le contexte défini.
• uninstall : Pour désinstaller un vérificateur ou un rapport, selon le contexte défini.
• run : Pour exécuter l'analyse.
• show : Pour afficher une liste de vérificateurs ou de rapports, selon le contexte défini.
• help : Afficher l'aide

Les valeurs context autorisées sont :

• checkers : Opérer avec les vérificateurs
• reports : Opérer avec les rapports

L'option target définit le chemin à analyser, ou le plugin (vérificateur/rapport) à installer/désinstaller.

Afficher tous les vérificateurs

.. code-block:: shell

ascli show checkers

---

Afficher tous les rapports

.. code-block:: shell

ascli show reports

---

Installer un vérificateur

.. code-block:: shell

ascli install checkers --target path/to/file.py

---

Installer un rapport

.. code-block:: shell

ascli install reports --target path/to/file.py

---

Désinstaller un vérificateur

.. code-block:: shell

ascli uninstall checkers --target path/to/file.py

ou

.. code-block:: shell

ascli uninstall checkers --target checker_name

---

Désinstaller un rapport

.. code-block:: shell

ascli uninstall reports --target path/to/file.py

ou

.. code-block:: shell

ascli uninstall reports --target checker_name

---

Exécuter l'analyse

.. code-block:: shell

ascli run --target path/to/file.py --name repo_name