Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

RustF CLI

rustf-cli is the fastest way to create, inspect, and maintain a RustF project. It is not just a scaffolder: it also handles schema workflows, database inspection, validation, project analysis, and MCP serving for AI tools.

Start Here

If you are new to the CLI, this is the shortest useful path:

  1. Install it: see Installation
  2. Create an app: Create a Project
  3. Generate pieces as the app grows: Generate Components
  4. Add database workflow: Database & Schemas
  5. Audit the project before commits: Analysis & Validation

Most Common Commands

rustf-cli new project my-app
rustf-cli new controller -n users
rustf-cli new crud -n posts
rustf-cli schema generate models
rustf-cli analyze project --detailed
rustf-cli validate

Task-Focused Guides

What the CLI Covers

  • Project scaffolding
  • Component generation
  • Database introspection
  • YAML schema workflows
  • Route and project analysis
  • Validation and consistency checks
  • Local MCP serving for AI assistants