eris/README.md

Eris Codebase Monitor

Summary

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

Installation

Ubuntu (21.10)

Install eris directly using pip, and apt install the tools eris relies on:

pip install git+https://github.com/ahamilton/eris@2021.12.22#subdirectory=eris
eris --apt-install-tools

Or install from source: (including tools)

git clone https://github.com/ahamilton/eris
cd eris
./install

Then to run:

eris -h
eris-webserver <project>  # Or a simple web interface.

Docker

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

Snap

# Download snap file from github releases page:
wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06_amd64.snap"
snap install --dangerous eris_2021.12.06_amd64.snap
rm eris_2021.12.06_amd64.snap    # The snap file is no longer needed.

AppImage

# Download AppImage file from github releases page:
wget "https://github.com/ahamilton/eris/releases/download/v2021-12-06/eris_2021.12.06.AppImage"
chmod +x eris_2021.12.06.AppImage
mv eris_2021.12.06.AppImage ~/bin/eris    # e.g. Put appimage in your PATH

Tools

File types(100)	Tools(58)
.*	contents • metadata • git_diff • git_blame • git_log
.py	python_syntax • python_unittests • pytest • pydoc • mypy • python_coverage • pycodestyle • pydocstyle • pyflakes • pylint • python_gut • python_mccabe • bandit
.pl .pm .t	perl_syntax • perldoc
.p6 .pm6	perl6_syntax
.pod .pod6	perldoc
.c .h	c_syntax_gcc • cppcheck
.cc .cpp .hpp	cpp_syntax_gcc • cppcheck
.rb	ruby_syntax
.lua	lua_syntax • lua_check
.js	js_syntax
.php	php8_syntax
.go	go_vet • godoc
.bash .sh .dash .ksh	shellcheck
.wasm	wasm_validate • wasm_objdump
.pdf	pdf2txt
.html .htm	html_syntax • html2text • elinks
.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	ar • nm
.o	objdump_headers • objdump_disassemble • readelf
.so	nm
.deb	dpkg_contents • dpkg_info
.rpm	rpm
.png .jpg .gif .bmp .tif .tiff .tga .ico .xpm	mediainfo • pil
.svg .svgz	cairosvg
.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