Enum UserCommand 

pub enum UserCommand {
    List {
        discourse: String,
        listing: String,
        page: u32,
        format: ListFormat,
    },
    Info {
        discourse: String,
        username: String,
        format: ListFormat,
    },
    Suspend {
        discourse: String,
        username: String,
        until: String,
        reason: String,
    },
    Unsuspend {
        discourse: String,
        username: String,
    },
    Silence {
        discourse: String,
        username: String,
        until: String,
        reason: String,
    },
    Unsilence {
        discourse: String,
        username: String,
    },
    Promote {
        discourse: String,
        username: String,
        role: RoleArg,
    },
    Demote {
        discourse: String,
        username: String,
        role: RoleArg,
    },
    Create {
        discourse: String,
        email: String,
        username: String,
        name: Option<String>,
        password_stdin: bool,
        approve: bool,
    },
    PasswordReset {
        discourse: String,
        username: String,
    },
    EmailSet {
        discourse: String,
        username: String,
        email: String,
    },
    Activity {
        discourse: String,
        username: String,
        since: Option<String>,
        types: String,
        limit: Option<u32>,
        format: ActivityFormatArg,
    },
    Groups {
        command: UserGroupsCommand,
    },
}

Variants

List

List users via the admin users endpoint.

Fields

discourse: String

Discourse name.

listing: String

Listing type: active | new | staff | suspended | silenced | staged.

page: u32

Page number (Discourse paginates 100 per page).

format: ListFormat

Output format.

Info

Show detailed info for a user.

Fields

discourse: String

Discourse name.

username: String

Username.

format: ListFormat

Output format.

Suspend

Suspend a user.

Fields

discourse: String

Discourse name.

username: String

Username.

until: String

When the suspension ends. ISO-8601 timestamp (e.g. 2026-12-31T00:00:00Z) or forever.

reason: String

Reason shown to the user and in the audit log.

Unsuspend

Remove a suspension from a user.

Fields

discourse: String

Discourse name.

username: String

Username.

Silence

Silence a user (prevents posting; less visible than suspend).

Fields

discourse: String

Discourse name.

username: String

Username.

until: String

When the silence ends. ISO-8601 timestamp; empty means indefinite.

reason: String

Reason shown to the user and in the audit log.

Unsilence

Lift a silence on a user.

Fields

discourse: String

Discourse name.

username: String

Username.

Promote

Grant the user the admin or moderator role.

Fields

discourse: String

Discourse name.

username: String

Username.

role: RoleArg

Role to grant.

Demote

Revoke the user’s admin or moderator role.

Fields

discourse: String

Discourse name.

username: String

Username.

role: RoleArg

Role to revoke.

Create

Create a new user. --approve also marks the account approved (needed when site requires manual approval). Password is either supplied via stdin (--password-stdin) or omitted — in the latter case the user will have to set one via the reset flow.

Fields

discourse: String

Discourse name.

email: String

New user’s email address.

username: String

New user’s username.

name: Option<String>

Display name (optional).

password_stdin: bool

Read the password from stdin instead of auto-reset.

approve: bool

Also mark the user approved (for sites with manual approval).

PasswordReset

Trigger Discourse’s password-reset email flow for a user.

Fields

discourse: String

Discourse name.

username: String

Username or email.

EmailSet

Set a user’s primary email address. Requires admin scope.

Fields

discourse: String

Discourse name.

username: String

Username.

email: String

New email address.

Activity

Show a user’s recent public activity (topics + replies by default).

Built for the “archive my own activity to a journal forum” loop — pipe the markdown output straight into dsc topic reply/topic new.

Fields

discourse: String

Discourse name (the source forum to read activity from).

username: String

Username whose activity to read.

since: Option<String>

How far back to look. Accepts 7d, 24h, 30m, 1w, 90s, or an ISO-8601 timestamp / date. Omit to fetch everything available.

types: String

Action types to include, comma-separated. Default: topics,replies. Also recognises: mentions, quotes, likes, edits, responses.

limit: Option<u32>

Hard cap on number of items returned.

format: ActivityFormatArg

Output format.

Groups

Manage a user’s group memberships.

Fields

command: UserGroupsCommand

Trait Implementations

impl FromArgMatches for UserCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for UserCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand