AtomShields Cli

AtomShields Cli — это интерфейс командной строки для использования программного обеспечения AtomShields <https://github.com/ElevenPaths/AtomShields>_

.. raw:: html

Установка

.. code-block:: shell

pip install atomshieldscli

Базовое использование

.. code-block:: shell

ascli --target --name <project_name>

Допустимые значения action:

• install: Устанавливает проверяющий модуль или отчёт, в зависимости от заданного контекста.
• uninstall: Удаляет проверяющий модуль или отчёт, в зависимости от заданного контекста.
• run: Запускает сканирование.
• show: Показывает список проверяющих модулей или отчётов, в зависимости от заданного контекста.
• help: Показывает справку.

Допустимые значения context:

• checkers: Работа с проверяющими модулями.
• reports: Работа с отчётами.

Опция target задаёт путь для сканирования или плагин (проверяющий модуль/отчёт) для установки/удаления.

Показать все проверки

.. code-block:: shell

ascli show checkers

---

Показать все отчёты

.. code-block:: shell

ascli show reports

---

Установка проверки

.. code-block:: shell

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

---

Установка отчёта

.. code-block:: shell

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

---

Удаление проверки

.. code-block:: shell

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

или

.. code-block:: shell

ascli uninstall checkers --target checker_name

---

Удаление отчёта

.. code-block:: shell

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

или

.. code-block:: shell

ascli uninstall reports --target checker_name

---

Запуск сканирования

.. code-block:: shell

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