eris/README.md
Andrew Hamilton fd4357c513 packaging: Update README with move to Gitlab
- github -> gitlab
- Not providing snaps or appimages on gitlab yet since it seems
  gitlab doesn't allow arbitrary files to be put on release pages.
  (They also weren't migrated in the import)
- Also have moved from ubuntu to debian.
2023-09-11 00:22:05 +10:00

4.3 KiB

Eris Codebase Monitor

Summary

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

Installation

Debian 12 (Bookworm)

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

sudo apt install pipx
pipx install --system-site-packages git+https://gitlab.com/ahamilton/eris@v2022.12.06#subdirectory=eris
eris --apt-install-tools

Or install from source: (including tools)

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

Then to run:

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

Docker

git clone https://gitlab.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

Tools

File types(101) Tools(58)
.* contentsmetadatagit_diffgit_blamegit_log
.py python_syntaxpython_unittestspytestpydocmypypython_coveragepycodestylepydocstylepyflakespylintpython_gutpython_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 php8_syntax
.go go_vetgodoc
.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 .jpeg .gif .bmp .tif .tiff .tga .ico .xpm mediainfopil
.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