Skip to main content

Command-Line Interface for atomshields package.

Project description


AtomShields Cli
===============

AtomShields Cli is a Command-Line Interface to use the software `AtomShields <https://github.com/ElevenPaths/AtomShields>`_

.. raw:: html

<a href="https://asciinema.org/a/l87EfxU2e3eNpwQ9F8Sbhpk3q?autoplay=1" target="_blank"><img src="https://asciinema.org/a/l87EfxU2e3eNpwQ9F8Sbhpk3q.png" width="835"/></a>


Installation
------------

.. code-block:: shell

pip install atomshieldscli


Basic usage
-----------

.. code-block:: shell

ascli <action> <context> --target <path> --name <project_name>

The allowed *action* values are:

- **install**: To install a checker or a report, depending the context setted.
- **uninstall**: To uninstall a checker or a report, depending the context setted.
- **run**: To run the scan.
- **show**: To show a checker list or a report list, depending the context setted.
- **help**: Show the help

The allowed *context* values are:

- **checkers**: Operate with checkers
- **reports**: Operate with reports

The *target* option set the path to scan, or the plugin (checker/report) to install/uninstall.


Show all checkers
-----------------

.. code-block:: shell

ascli show checkers

------------------------------------------------------------------------------------------

Show all reports
----------------

.. code-block:: shell

ascli show reports

------------------------------------------------------------------------------------------


Install checker
---------------

.. code-block:: shell

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

------------------------------------------------------------------------------------------

Install report
--------------

.. code-block:: shell

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

------------------------------------------------------------------------------------------

Uninstall checker
-----------------

.. code-block:: shell

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

or

.. code-block:: shell

ascli uninstall checkers --target checker_name

------------------------------------------------------------------------------------------

Uninstall report
----------------

.. code-block:: shell

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

or

.. code-block:: shell

ascli uninstall reports --target checker_name

------------------------------------------------------------------------------------------

Run the scan
------------

.. code-block:: shell

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for atomshieldscli, version 1.10
Filename, size & hash File type Python version Upload date
atomshieldscli-1.10.tar.gz (9.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page