ecci

ecci is the end-user command-line interface (CLI) for checking files and directories against their applicable EditorConfig settings.

Installation

Building from source requires a current stable Rust toolchain with Cargo and the EditorConfig Core C development library (libeditorconfig). On Debian or Ubuntu, install it with sudo apt-get install libeditorconfig-dev; on Alpine, use apk add editorconfig-dev.

Then clone the repository and build the CLI:

git clone https://github.com/editorconfig-ecci/ecci.git
cd ecci
cargo build --release --package ecci

Basic usage

Pass files or directories to the CLI. Directories are searched recursively; if no path is supplied, the current directory is used.

cargo run --package ecci -- src tests

The command writes its summary to standard output, diagnostics to standard error, and returns a nonzero status for violations or execution errors. See the CLI documentation for options and the complete exit-status contract.

Documentation

• CLI usage, configuration, and checks
• .ecciignore configuration
• GitHub Action usage
• Development and testing
• Technical design documentation
• Documentation governance
• MIT License