eris/README.md

2.8 KiB

Vigil Code Monitor

Summary

Vigil maintains an up-to-date set of reports for every file in a codebase.

Installation

(Tested in Ubuntu 18.04)

# git clone https://github.com/ahamilton/vigil
# cd vigil
# ./install-dependencies
# pip3 install .

To test its working properly:

# ./test-all

then to run:

# vigil <directory_path>

Tools

Extensions Tools
.* contents • metadata • git_blame • git_log
.py python_syntax • python_unittests • pydoc • mypy • python_coverage • pycodestyle • pyflakes • pylint • python_gut • python_modulefinder • dis • python_mccabe • bandit
.pl .pm .t perl_syntax • perldoc • perltidy
.pod .pod6 perldoc
.java uncrustify
.c .h c_syntax_gcc • splint • uncrustify • cppcheck
.o objdump_headers • objdump_disassemble • readelf
.cc .cpp .hpp cpp_syntax_gcc • bcpp • uncrustify • cppcheck
.pdf pdf2txt
.html html_syntax • tidy • html2text
.php php7_syntax
.zip unzip
.tar.gz .tgz tar_gz
.tar.bz2 tar_bz2
.a .so nm
.png .jpg .gif .bmp .ppm .tiff .tga pil • pil_half
.bash .sh .dash .ksh shellcheck