Installation

sui-clippy CLI

From a clone of the repository:

cargo install --path crates/sui-clippy

You get the sui-clippy binary (and cargo-sui-clippy if your Cargo.toml installs both bins from that crate).

Optional: Move compiler integration

For --typed (compiler-backed diagnostics), build with the large Sui git dependency:

cargo install --path crates/sui-clippy --features move_compiler

Optional: LSP

cargo install --path crates/sui-clippy-lsp

Then configure your editor to run sui-clippy-lsp with stdio (see Language server).

mdBook (to read or author this book)

Install mdBook, then from the book/ directory:

mdbook build

HTML output is written to book/build/ (see book.toml).