Installation
Prerequisites
Section titled “Prerequisites”- Rust 1.85+ (for building from source)
- PostgreSQL 16+ (for the platform API)
- Node.js 20+ (for the catalog compiler and dashboard)
Install from Source
Section titled “Install from Source”-
Clone the repository:
Terminal window git clone https://github.com/crabnebula-dev/fleet.gitcd fleet -
Compile the catalog:
Terminal window cd catalog/compilerpnpm installpnpm run compilecd ../.. -
Build Fleet:
Terminal window cargo build --release -
Verify installation:
Terminal window ./target/release/fleet scan --help
Docker (for CI)
Section titled “Docker (for CI)”docker build -f integrations/Dockerfile.scanner -t fleet-scanner:latest .docker run --rm -v $(pwd):/workspace fleet-scanner:latest \ fleet scan --path /workspace --output prettyDatabase Setup (for Platform API)
Section titled “Database Setup (for Platform API)”If you want the dashboard, evidence storage, and API:
-
Create a PostgreSQL database:
Terminal window createdb fleet -
Set the database URL:
Terminal window export DATABASE_URL="postgres://$(whoami)@localhost/fleet" -
Run migrations:
Terminal window ./target/release/fleet-server# Migrations run automatically on startup
Dashboard Setup
Section titled “Dashboard Setup”cd dashboardpnpm installpnpm dev# Opens at http://localhost:3000Quick Verification
Section titled “Quick Verification”# Scan the fleet project itselffleet scan --path . --output prettyExpected output:
Fleet CRA Assessment ScannerScanning: .
Catalog: CRA Default v1.0.0 (401 requirements)Languages: rust, javascriptSource files: 93, Manifests: 4, Lockfiles: 4CBOM: 314 crypto primitives (301 approved, 6 deprecated, 7 prohibited)
=== CRA Assessment Results ===
Findings: 152 Pass: 55 Fail: 40 Review: 57
Scan completed in 12.0sNext Steps
Section titled “Next Steps”- Your First Scan — detailed walkthrough of scanning a project
- CI Integration — set up continuous scanning in your pipeline
- LLM Configuration — enable AI-powered evidence review