Skip to content
Assura

Quick Start

Use this path for a first local check.

  1. Install Assura

    Terminal window
    curl -fsSL https://raw.githubusercontent.com/rothnic/assura/master/website/public/install.sh | sh

    The installer downloads a release archive and does not require a source checkout. Windows users can run the PowerShell installer from the Installation guide or download the zip from GitHub Releases.

  2. Initialize configuration

    Terminal window
    assura init

    This creates .assura/config.yml if one does not already exist.

  3. Write the first useful project shape

    For a small Rust CLI or library, start with the files a new clone should always have:

    structure:
      ./:
        extra: false
        README.md: exists:1
        Cargo.toml: exists:1
        src/: exists:1
        "*.lock": exists:0-1
      src/:
        .rs: snake_case
    exclude:
      - "target/**"

    This keeps the project root closed, requires the core files, allows one optional lockfile, and checks direct Rust files under src/.

  4. Run the supported validation command

    Terminal window
    assura check

  5. Inspect JSON output when needed

    Terminal window
    assura check --format json .

  6. Use the same command in CI

    Terminal window
    curl -fsSL https://raw.githubusercontent.com/rothnic/assura/master/website/public/install.sh | sudo env BIN_DIR=/usr/local/bin sh
    assura check --format text

Next Steps

Section titled “Next Steps”