Maudit

Prerequisites

• Rust (1.83 or later)
• A code editor (e.g. Visual Studio Code, RustRover, Helix, etc.)
• A terminal emulator (e.g. Windows Terminal, Terminal.app, Ghostty, etc.)

We recommend using rustup to install Rust. Maudit is intended to be used with the latest stable version of Rust and does not require nightly features.

Once Rust is installed, run the following command to ensure the latest stable version of Rust is being used:

rustup default stable

Installing Maudit

Maudit provides a CLI tool for interacting with websites created using the library and generating new ones. To install the CLI tool, run the following command:

cargo install maudit-cli

This will install the maudit binary in your Cargo bin directory. You can now run maudit --help to see the available commands and options.

If you do not wish to use the CLI, or are integrating Maudit into an existing project, follow the instructions in the manual installation guide.

Creating a new project

To create a new Maudit project, run the following command:

maudit init

Maudit will then ask you a series of questions to configure your project. Once complete, you can navigate to the project directory and start the development server using maudit dev:

cd my-website
maudit dev