Console commands and the CLI

cargo install --git https://github.com/NavreeHQ/navree navree-cli

navree --help

Create Navree apps, generate code and run the dev loop

Usage: navree <COMMAND>

Commands:
  new                Create a new app in ./NAME
  make:module        Generate a feature module: mod.rs, controller.rs, service.rs, entity.rs, dto.rs, migrations/, tests/
  make:controller    Generate a controller in a module (controllers/NAME.rs)
  make:service       Generate a service in a module (services/NAME.rs)
  make:entity        Generate a database entity in a module (entities/NAME.rs)
  make:migration     Generate a migration in a module (create_TABLE_table creates the table)
  make:job           Generate a queued job in a module (jobs/NAME.rs)
  make:event         Generate an event in a module (events/NAME.rs)
  make:listener      Generate an event listener in a module (listeners/NAME.rs)
  make:mail          Generate a mail with HTML and text templates in a module (mail/NAME.rs)
  make:notification  Generate a notification in a module (notifications/NAME.rs)
  make:policy        Generate ability rules in a module (policies/NAME.rs), added to src/abilities.rs
  make:command       Generate a CLI command in a module (commands/NAME.rs)
  make:test          Generate a test in a module (tests/NAME.rs)
  dev                Serve the app, rebuilding and restarting it when the code changes
  help               Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Every other command runs in the app binary: `navree <command> [args...]` is `cargo run --quiet -- <command> [args...]` (migrate, migrate:fresh --seed, db:seed, queue:work, schedule:run, routes, check --graph, openapi:export, key:generate, <module>:<command>, ...). `navree list` shows the app's commands.

navree new blog

Created blog in /home/ada/code/blog
It depends on navree at /home/ada/src/navree/crates/navree.

Next steps:
  cd blog
  navree key:generate     # then set APP_KEY in .env
  navree dev              # http://127.0.0.1:8080/api/docs

navree make:module posts --crud

  created  src/modules/posts/mod.rs
  created  src/modules/posts/controller.rs
  created  src/modules/posts/service.rs
  created  src/modules/posts/entity.rs
  created  src/modules/posts/dto.rs
  created  src/modules/posts/migrations/mod.rs
  created  src/modules/posts/migrations/m20261026_081536_create_posts_table.rs
  created  src/modules/posts/tests/mod.rs
  updated  src/modules/mod.rs
  updated  src/app.rs

navree make:job posts publish_post

  created  src/modules/posts/jobs/publish_post.rs
  created  src/modules/posts/jobs/mod.rs
  updated  src/modules/posts/mod.rs
  updated  src/modules/posts/mod.rs

navree dev
navree dev --no-web -- --addr 0.0.0.0:8080

navree migrate:status
cargo run -- migrate:status        # the same, without the CLI
./target/release/blog migrate      # a release build

fn main() -> Result<(), navree::kernel::BoxError> {
    // `.env`, then `config/app.toml`, then `APP_*` environment variables.
    blog::app(ConfigSources::defaults()).run()
}

Usage: <command> [args...]

Built-in commands:
  check [--graph]     Validate the module graph without constructing providers
  help                List the available commands

Commands:
  key:generate        Print a new application key for `app.key` (APP_KEY)
  serve               Start the HTTP server ([--addr HOST:PORT])
  routes              List every route with its access declaration ([--json])
  down                Put the app into maintenance mode ([--retry SECS] [--message TEXT])
  up                  Bring the app out of maintenance mode
  migrate             Run every pending migration
  migrate:rollback    Roll back the last batch of migrations
  migrate:fresh       Drop every table and run every migration ([--seed])
  migrate:status      Show which migrations have run
  db:seed             Run the seeders ([name...] to run only some)
  cache:clear         Remove every entry from the cache store
  queue:work          Run queued jobs until shutdown ([--queue a,b] [--once] [--stop-when-empty] [--max-jobs N])
  queue:failed        List the failed jobs
  queue:retry         Put failed jobs back on their queues (<id> or all)
  queue:flush         Delete every failed job
  schedule:run        Run the scheduled tasks due this minute (call it every minute from cron)
  schedule:work       Run the scheduler in the foreground, ticking every minute until stopped
  schedule:list       List the scheduled tasks and their next run
  access:role         Create a role: access:role <name> [description]
  access:grant        Give a role a permission: access:grant <role> <permission>
  access:explain      Show the rule deciding a check: access:explain <user> <action> <subject> [id]
  audit:prune         Delete audit entries older than the retention period ([--days N])
  openapi:export      Write the OpenAPI document to a file ([path], default openapi.json)
  crm:task-reminders  Notify everyone of their open tasks due today (UTC)

navree check

module graph OK: 33 modules, 84 providers

navree routes

METHOD  PATH                                  NAME                            ACCESS                         MODULE
POST    /api/auth/login                       auth.login                      public                         AuthModule
GET     /api/auth/me                          auth.me                         auth                           AuthModule
GET     /api/v1/deals                                                         can:read Deal                  DealsModule
POST    /api/v1/deals/{id}/move                                               can:move Deal from id          DealsModule
GET     /health/ready                         health.ready                    public                         ObserveModule
...

62 routes

navree migrate:status

Batch   Status   Migration
1       Ran      audit/m20261025_000001_create_audit_logs
1       Ran      auth/m20261025_000001_create_users_table
1       Ran      auth/m20261025_000002_create_refresh_tokens_table
...

navree db:seed
navree schedule:list
navree queue:work --stop-when-empty

Seeded: crm-roles
Seeded: crm-demo
Expression  Next run              Task
0 8 * * *   2026-10-27 08:00 UTC  crm:task-reminders (without overlapping)
0 3 * * *   2026-10-27 03:00 UTC  audit:prune (without overlapping)
Processed 0 job attempt(s): 0 succeeded, 0 released for retry, 0 failed.

use navree::kernel::{AppContext, BoxError, CommandSpec};
use navree::storage::Disk;

/// `exports:clear [--dry-run]`: deletes every generated export.
pub fn clear_exports() -> CommandSpec {
    CommandSpec::new(
        "exports:clear",
        "Delete every generated export ([--dry-run])",
        run,
    )
}

async fn run(ctx: AppContext, args: Vec<String>) -> Result<(), BoxError> {
    let dry_run = args.iter().any(|arg| arg == "--dry-run");
    if let Some(unknown) = args.iter().find(|arg| *arg != "--dry-run") {
        return Err(format!("unknown option `{unknown}` (expected --dry-run)").into());
    }
    let disk = ctx.get::<Disk>().await?;
    let files = disk.list("exports").await?;
    if !dry_run {
        for file in &files {
            disk.delete(file).await?;
        }
    }
    println!("{} {} export(s).", if dry_run { "Would delete" } else { "Deleted" }, files.len());
    Ok(())
}

mod commands;

use navree::prelude::*;

#[module(register = Self::wire)]
pub struct ExportsModule;

impl ExportsModule {
    fn wire(&self, m: &mut ModuleBuilder) {
        m.command(commands::clear::clear_exports());
        // navree:wire
    }
}

navree exports:clear --dry-run

Would delete 3 export(s).

fn wire(&self, m: &mut ModuleBuilder) {
    m.command(clear_exports());
    m.schedule(|s| {
        s.command("exports:clear", &[]).daily_at("04:00").without_overlapping();
    });
}

use navree::prelude::*;
use navree::storage::{Disk, DiskConfig, StorageOptions};
use navree::testing::TestApp;

use super::ExportsModule;

#[tokio::test]
async fn clearing_exports_deletes_them() {
    let app = TestApp::builder()
        .module(StorageModule::for_root(StorageOptions {
            default: "memory".into(),
            disks: [("memory".to_owned(), DiskConfig::Memory)].into(),
            ..StorageOptions::default()
        }))
        .module(ExportsModule)
        .build()
        .await;
    let disk = app.get::<Disk>().await;
    disk.put("exports/contacts.csv", "id,name\n").await.unwrap();

    app.run_command("exports:clear", &[]).await.unwrap();

    assert!(disk.list("exports").await.unwrap().is_empty());
    assert!(app.run_command("exports:clear", &["--force"]).await.is_err());
    app.shutdown().await.unwrap();
}