Quickstart
-
Lint the workspace
Terminal window skif # the workspace containing the current directoryskif path/to/pkg # the workspace root is the nearest ancestor that declares a workspace -
Write a starter configuration
Terminal window skif initskif initwrites a commentedskif.tomlwith a#:schemadirective, so editors with Taplo or Even Better TOML validate and complete the file. It refuses to overwrite an existing configuration. -
Apply fixes
Terminal window skif --fix # safe fixes, lint again, then run the package manager's installskif --fix-unsafe # also apply unsafe fixes--fixis refused whenCIis truthy. Pass--no-installto skip the install step. -
Tune rules
Terminal window skif --rule unsorted-dependencies=off --fail-on-warningsskif rules # list every rule -
Run it in CI
- uses: actions/checkout@v7- uses: Goldziher/skif@v0with:fail-on-warnings: true
Output formats
Section titled “Output formats”skif --format json # one JSON document on stdoutskif --format sarif --output skif.sarif # code scanningskif --format github # workflow annotations