AtomShields Cli

AtomShields Cli ist eine Befehlszeilenschnittstelle zur Nutzung der Software AtomShields <https://github.com/ElevenPaths/AtomShields>_

.. raw:: html

Installation

.. code-block:: shell

pip install atomshieldscli

Grundlegende Verwendung

.. code-block:: shell

ascli --target --name <project_name>

Die zulässigen action-Werte sind:

• install: Um einen Prüfer oder einen Bericht zu installieren, abhängig vom gesetzten Kontext.
• uninstall: Um einen Prüfer oder einen Bericht zu deinstallieren, abhängig vom gesetzten Kontext.
• run: Um den Scan auszuführen.
• show: Um eine Liste der Prüfer oder eine Liste der Berichte anzuzeigen, abhängig vom gesetzten Kontext.
• help: Hilfe anzeigen

Die zulässigen context-Werte sind:

• checkers: Mit Prüfern arbeiten
• reports: Mit Berichten arbeiten

Die Option target legt den zu scannenden Pfad oder das zu installierende/deinstallierende Plugin (Prüfer/Bericht) fest.

Alle Prüfer anzeigen

.. code-block:: shell

ascli show checkers

---

Alle Berichte anzeigen

.. code-block:: shell

ascli show reports

---

Prüfer installieren

.. code-block:: shell

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

---

Bericht installieren

.. code-block:: shell

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

---

Prüfer deinstallieren

.. code-block:: shell

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

oder

.. code-block:: shell

ascli uninstall checkers --target checker_name

---

Bericht deinstallieren

.. code-block:: shell

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

oder

.. code-block:: shell

ascli uninstall reports --target checker_name

---

Scan ausführen

.. code-block:: shell

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