Adding a plugin (plugin add)

Every capability in umbral — auth, sessions, the admin, background tasks, REST — ships as a plugin. Adding one is two steps: depend on the crate, then register it on your App::builder(). umbral plugin add does the first and shows you the second.

Code

bash

umbral plugin add auth

Code

text

Running: cargo add umbral-auth
    Adding umbral-auth v0.0.12 to dependencies
 
Added `umbral-auth`. Wire it into your App in src/main.rs:
 
    App::builder()
        .plugin(AuthPlugin::default())
        // ... your other plugins / models ...
        .build_deferred()?;

<name> is a short name (auth, sessions, admin, tasks, rest, …) or the full crate name (umbral-auth). Either resolves to the same crate and the correct Plugin struct — including the irregular ones (oauth → OAuthPlugin, openapi → OpenApiPlugin, livereload → LiveReloadPlugin).

Info

`umbral plugin add` only adds the dependency and prints the wiring line — it doesn't edit `src/main.rs` for you, so it never has to guess the shape of your builder. Paste the `.plugin(...)` line where your other plugins are registered.

A name it doesn't recognize

An unknown name is passed straight through to cargo add, so a third-party umbral plugin works too — you just don't get a wiring hint the tool can't know:

Code

bash

umbral plugin add some-community-plugin
# note: `some-community-plugin` is not a built-in umbral plugin — adding it as a plain crate.
# Running: cargo add some-community-plugin

Passing flags to cargo add

Anything after -- is forwarded verbatim to cargo add:

Code

bash

umbral plugin add storage -- --features s3
umbral plugin add rest -- --dry-run

Requirements

plugin add edits Cargo.toml, so it must run inside a Cargo project (it walks up for a Cargo.toml the same way cargo does). Outside one it errors and points you at umbral startproject.

Adding a plugin (plugin add)

A name it doesn't recognize

Passing flags to cargo add

Requirements

See also