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