Enum Commands 

pub enum Commands {
    List {
        format: OutputFormat,
        tags: Option<String>,
        open: bool,
        verbose: bool,
        command: Option<ListCommand>,
    },
    Add {
        names: String,
        interactive: bool,
    },
    Import {
        path: Option<PathBuf>,
    },
    Update {
        name: String,
        parallel: bool,
        max: Option<usize>,
        post_changelog: bool,
        yes: bool,
    },
    Emoji {
        command: EmojiCommand,
    },
    Topic {
        command: TopicCommand,
    },
    Category {
        command: CategoryCommand,
    },
    Group {
        command: GroupCommand,
    },
    User {
        command: UserCommand,
    },
    Invite {
        command: InviteCommand,
    },
    ApiKey {
        command: ApiKeyCommand,
    },
    Pm {
        command: PmCommand,
    },
    Backup {
        command: BackupCommand,
    },
    Palette {
        command: PaletteCommand,
    },
    Plugin {
        command: PluginCommand,
    },
    Theme {
        command: ThemeCommand,
    },
    Setting {
        command: SettingCommand,
    },
    Tag {
        command: TagCommand,
    },
    Post {
        command: PostCommand,
    },
    Open {
        discourse: String,
    },
    Harden {
        host: String,
        ssh_user: String,
        new_user: Option<String>,
        ssh_port: Option<u16>,
        pubkey_file: PathBuf,
    },
    Analytics {
        discourse: String,
        since: String,
        compare: bool,
        snapshot: bool,
        periods: Option<String>,
        section: SectionArg,
        format: AnalyticsFormat,
    },
    Search {
        discourse: String,
        query: String,
        format: ListFormat,
    },
    Upload {
        discourse: String,
        file: PathBuf,
        upload_type: String,
        format: ListFormat,
    },
    Config {
        command: Option<ConfigCommand>,
    },
    Completions {
        shell: CompletionShell,
        dir: Option<PathBuf>,
    },
    Man {
        dir: PathBuf,
    },
    Version,
}

Variants

List

List configured Discourses.

Fields

format: OutputFormat

Output format for the listing.

tags: Option<String>

Filter by tags (comma/semicolon separated, match-any).

open: bool

Open each listed Discourse base URL in a browser tab/window.

verbose: bool

Include empty results and verbose listing details where supported.

command: Option<ListCommand>

Add

Add one or more Discourses to the config.

Fields

names: String

Comma-separated discourse names to add.

interactive: bool

Prompt for additional optional fields while adding.

Import

Import Discourses from a file or stdin.

Fields

path: Option<PathBuf>

Path to import input (text/CSV). Reads stdin when omitted.

Update

Run remote OS + Discourse update workflow for one or all Discourses.

Fields

name: String

Discourse name, or ‘all’ to update every configured Discourse.

parallel: bool

Parallel update mode for dsc update all.

max: Option<usize>

Maximum workers when parallel mode is enabled (default: 3).

post_changelog: bool

Disable changelog posting (posting prompt is on by default).

yes: bool

Auto-confirm changelog posting prompt (non-interactive mode).

Emoji

Manage custom emoji.

Fields

command: EmojiCommand

Topic

Pull/push/sync topics as local Markdown.

Fields

command: TopicCommand

Category

List/copy/pull/push categories.

Fields

command: CategoryCommand

Group

List/inspect/copy groups.

Fields

command: GroupCommand

User

Operations that act from a user’s perspective.

Fields

command: UserCommand

Invite

Send invites — single or bulk from a file.

Fields

command: InviteCommand

ApiKey

Manage API keys (admin scope).

Fields

command: ApiKeyCommand

Pm

Send and list private messages.

Fields

command: PmCommand

Backup

Create/list/restore backups.

Fields

command: BackupCommand

Palette

List/pull/push color palettes.

Fields

command: PaletteCommand

Plugin

List/install/remove plugins.

Fields

command: PluginCommand

Theme

List/install/remove/pull/push/duplicate themes.

Fields

command: ThemeCommand

Setting

Update site settings.

Fields

command: SettingCommand

Tag

Manage the tag taxonomy: list/pull/push tags and tag groups.

Fields

command: TagCommand

Post

Post-level operations: edit / delete / move.

Fields

command: PostCommand

Open

Open a Discourse in the default browser.

Fields

discourse: String

Discourse name.

Harden

Harden a fresh Ubuntu server reachable via ssh root@host.

Stage 1 (current): creates a non-root sudo user, installs the given pubkey to their authorized_keys, and verifies the new-user SSH login works. Does NOT yet tighten sshd_config, install Docker / fail2ban / etc — those come in follow-up releases.

Defaults can be overridden in the [harden] block of dsc.toml; the flags below override that block on a per-run basis.

Fields

host: String

Target hostname or IP (reachable via SSH).

ssh_user: String

Username to SSH in as initially. Defaults to root, which is what a fresh cloud-provisioned box typically has.

new_user: Option<String>

Username for the new sudo-enabled non-root account. Overrides [harden].new_user from dsc.toml. Built-in default: discourse.

ssh_port: Option<u16>

SSH port to move the daemon to in stage 2. Overrides [harden].ssh_port. Built-in default: 2227. Parsed now so the CLI is stable; not yet applied in stage 1.

pubkey_file: PathBuf

Path to an SSH public key file whose contents will be added to the new user’s authorized_keys. A typical value is ~/.ssh/<hostname>.pub — the per-server keypair pattern in the Bawmedical hardening playbook.

Analytics

Community-health analytics — growth, activity, and health metrics for a Discourse, with optional period-over-period comparison.

See spec/analytics.md for the full spec. v1 ships every metric that maps onto a single /admin/reports/{id}.json endpoint; derivation-heavy ones (e.g. lost regulars, top-10 share) print — (n/i) until follow-up implementation lands.

Fields

discourse: String

Discourse name.

since: String

Window to report on. Same syntax as dsc user activity --since (e.g. 7d, 24h, 1m, ISO-8601). Ignored when --snapshot is set. Default: 30d.

compare: bool

Also fetch the immediately preceding window of equal length and show a delta column. Mutually exclusive with --snapshot.

snapshot: bool

Multi-window snapshot mode. Reports each metric across several preset windows (--periods) so you see growth/health trends at a glance. Replaces --since + --compare.

periods: Option<String>

Comma-separated periods for --snapshot. Default: 24h,7d,30d,1y.

section: SectionArg

Restrict output to one section.

format: AnalyticsFormat

Output format. table is DuckDB-style box-drawing; falls through to text automatically when stdout isn’t a TTY.

Search

Search topics on a Discourse.

Fields

discourse: String

Discourse name.

query: String

Search query (passed through verbatim, including any Discourse filter syntax like category:foo or @user).

format: ListFormat

Output format.

Upload

Upload a file. Prints the resulting upload:// short URL by default.

Fields

discourse: String

Discourse name.

file: PathBuf

Path to the file to upload.

upload_type: String

Discourse upload context. Default composer is correct for embedding in posts; other values include avatar, profile_background, card_background, custom_emoji.

format: ListFormat

Output format. Text mode prints just the short URL.

Config

Inspect and validate configuration.

Fields

command: Option<ConfigCommand>

Completions

Generate shell completion scripts.

Fields

shell: CompletionShell

Target shell.

dir: Option<PathBuf>

Output directory. Prints to stdout when omitted.

Man

Generate man pages for dsc and every subcommand.

Writes one ROFF-formatted file per (sub)command (e.g. dsc.1, dsc-tag-pull.1) into the given directory. Distro packagers install these into section 1 of the man path. Run gzip -9 on the output if your packaging convention expects compressed pages.

Fields

dir: PathBuf

Output directory. Required - this command always writes to disk.

Version

Print the dsc version.

Trait Implementations

impl FromArgMatches for Commands

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 Commands

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