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
Metadata
Release files for atomshieldscli 1.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| atomshieldscli-1.10.tar.gz | 9.7 kB | Without provenance | Details for atomshieldscli-1.10.tar.gz |
Release files / atomshieldscli-1.10.tar.gz
| Download URL | atomshieldscli-1.10.tar.gz |
|---|---|
| Size | 9.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2875cc7fffd4e40d2f0d628dacb913db54eb0958aa869ca7b0bb4e3258d78bb6
|
|
BLAKE2b-256 checksum How to use checksums |
c81a2b04dd3506818d0c9ad0d6910e0bbba7ab0cd1773411f3424abb251d35c6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for atomshieldscli 1.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.