Skip to main content

Command-Line Interface for atomshields package.

Project description

What is AtomShields Cli?

Command-Line Interface to use the software AtomShields

Installation

pip install atomshields-cli

Basic usage

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

ascli show checkers

Show all reports

ascli show reports

Install checker

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

Install report

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

Uninstall checker

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

or

ascli uninstall checkers --target checker_name

Uninstall report

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

or

ascli uninstall reports --target checker_name

Run the scan

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.

Source Distribution

atomshieldscli-1.9.tar.gz (9.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page