eris/README.md

4.9 KiB

Eris Codebase Monitor

Summary

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

Installation

Ubuntu (20.04)

# git clone https://github.com/ahamilton/eris
# cd eris
# ./install-dependencies
# python3.8 -m pip install .
# eris -h

Flatpak

# flatpak install org.freedesktop.Sdk/x86_64/18.08    # Install the required runtime
# Download flatpak bundle file from github releases page:
  https://github.com/ahamilton/eris/releases
# flatpak install eris-2019-12-22.flatpak    # Install the downloaded bundle
# flatpak run --filesystem=host com.github.ahamilton.eris -h

There is a wrapper script available to make running easier:

# git clone https://github.com/ahamilton/eris
# cp eris/eris-flatpak ~/bin/eris    # e.g. Put wrapper script in your PATH
# eris -h

Docker

# git clone https://github.com/ahamilton/eris
# cd eris
# sudo docker build -t eris .
# cp eris-docker ~/bin/eris    # e.g. Put wrapper script in your PATH
# eris -h

AppImage

# Download AppImage file from github releases page:
  https://github.com/ahamilton/eris/releases
# chmod +x eris-2019-12-22.AppImage
# mv eris-2019-12-22.AppImage ~/bin/eris    # e.g. Put appimage in your PATH
# eris -h

Tools

Extensions(98) Tools(60)
.* contentsmetadatagit_blamegit_log
.py python_syntaxpython_unittestspytestpydocmypypython_coveragepycodestylepydocstylepyflakespylintpython_gutpython_modulefinderdispython_mccabebandit
.pl .pm .t perl_syntaxperldoc
.p6 .pm6 perl6_syntax
.pod .pod6 perldoc
.c .h c_syntax_gcccppcheck
.cc .cpp .hpp cpp_syntax_gcccppcheck
.rb ruby_syntax
.lua lua_syntaxlua_check
.js js_syntax
.php php7_syntax
.go go_vetgolintgodoc
.bash .sh .dash .ksh shellcheck
.wasm wasm_validatewasm_objdump
.pdf pdf2txt
.html .htm html_syntaxhtml2textelinks
.yaml .yml yamllint
.md .epub .docx .odt .rst pandoc
.zip .jar .apk .egg .whl zipinfo
.tar.gz .tgz tar_gz
.tar.bz2 tar_bz2
.rar unrar
.7z 7z
.xz unxz
.a arnm
.o objdump_headersobjdump_disassemblereadelf
.so nm
.deb dpkg_contentsdpkg_info
.rpm rpm
.png .jpg .gif .bmp .tif .tiff .tga mediainfopil
.svg .svgz svglib
.mkv .mka .mks .ogg .ogm .avi .wav .mpeg .mpg .vob .mp4 .mpgv .mpv .m1v .m2v .mp2 .mp3 .asf .wma .wmv .qt .mov .rm .rmvb .ra .ifo .ac3 .dts .aac .flac .aiff .aifc .au .iff .flv .srt .ssa .ass .sami mediainfo
.iso isoinfo