AtomShields Cli

AtomShields Cli é uma Interface de Linha de Comando para usar o software AtomShields <https://github.com/ElevenPaths/AtomShields>_

.. raw:: html

Instalação

.. code-block:: shell

pip install atomshieldscli

Uso básico

.. code-block:: shell

ascli --target --name <project_name>

Os valores permitidos de action são:

• install: Para instalar um verificador ou um relatório, dependendo do contexto definido.
• uninstall: Para desinstalar um verificador ou um relatório, dependendo do contexto definido.
• run: Para executar a varredura.
• show: Para mostrar uma lista de verificadores ou uma lista de relatórios, dependendo do contexto definido.
• help: Mostrar a ajuda

Os valores permitidos de context são:

• checkers: Operar com verificadores
• reports: Operar com relatórios

A opção target define o caminho para varredura, ou o plugin (verificador/relatório) para instalar/desinstalar.

Mostrar todos os verificadores

.. code-block:: shell

ascli show checkers

---

Mostrar todos os relatórios

.. code-block:: shell

ascli show reports

---

Instalar verificador

.. code-block:: shell

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

---

Instalar relatório

.. code-block:: shell

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

---

Desinstalar verificador

.. code-block:: shell

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

ou

.. code-block:: shell

ascli uninstall checkers --target checker_name

---

Desinstalar relatório

.. code-block:: shell

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

ou

.. code-block:: shell

ascli uninstall reports --target checker_name

---

Executar a varredura

.. code-block:: shell

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