Skip to content
No description, website, or topics provided.
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
atomshieldscli Remove big banner Apr 2, 2018
.gitignore v1.0.1 Apr 2, 2018
CHANGELOG.md Add custom steps Apr 3, 2018
LICENSE
MANIFEST.in Add version Mar 27, 2018
README.rst Fix Pypi name Apr 4, 2018
VERSION Add setup log Apr 3, 2018
requirements.txt Update version atomshields Apr 4, 2018
setup.py Add setup log Apr 3, 2018

README.rst

AtomShields Cli

AtomShields Cli is a Command-Line Interface to use the software AtomShields

Installation

pip install atomshieldscli

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
You can’t perform that action at this time.