Enum SettingCommand 

pub enum SettingCommand {
    Set {
        discourse: Option<String>,
        setting: Option<String>,
        value: Option<String>,
        tags: Option<String>,
    },
    Get {
        discourse: String,
        setting: String,
    },
    List {
        discourse: String,
        format: ListFormat,
        verbose: bool,
    },
    Pull {
        discourse: String,
        local_path: PathBuf,
        changed_only: bool,
        category: Option<String>,
    },
    Push {
        discourse: String,
        local_path: PathBuf,
        reset_unlisted: bool,
    },
    Diff {
        source: String,
        target: String,
        changed_only: bool,
        category: Option<String>,
        format: ListFormat,
    },
}

Variants

Set

Set a site setting on a Discourse (or all tagged Discourses).

Usage: dsc setting set dsc setting set –tags <tag1,tag2>

Fields

discourse: Option<String>

Discourse name. Required unless --tags is provided.

setting: Option<String>

Setting key. Required.

value: Option<String>

Setting value. Required.

tags: Option<String>

Tag filter (comma/semicolon separated, match-any). Apply across all Discourses matching any of the tags. When set, omit <discourse> and pass <setting> <value> as the only positionals.

Get

Get the current value of a site setting.

Fields

discourse: String

Discourse name.

setting: String

Setting key.

List

List all site settings.

Fields

discourse: String

Discourse name.

format: ListFormat

Output format.

verbose: bool

Show output even when list is empty.

Pull

Snapshot all site settings (with metadata) to a local file.

See spec/setting-sync.md for the full schema and workflow. The generated file is a self-documenting YAML (or JSON) including each setting’s default, type, category, and description.

Fields

discourse: String

Discourse name.

local_path: PathBuf

Output path. Format detected by extension (.json → JSON, otherwise YAML). Defaults to settings.yaml.

changed_only: bool

Only include settings whose value differs from default. Produces a manageable file (~50-100 entries) suitable for version control.

category: Option<String>

Limit to settings in this category (e.g. required, email, security).

Push

Apply a settings snapshot file to a Discourse (idempotent).

Compares each setting in the file against the server and PUTs only values that differ. Combine with --dry-run to preview the plan.

Fields

discourse: String

Discourse name.

local_path: PathBuf

Path to the settings snapshot file (YAML or JSON).

reset_unlisted: bool

For settings present on the server but absent from the file, reset them to their default value. Off by default (file describes only the values you care about).

Diff

Compare site settings between two sources.

Each source can be a Discourse name (live fetch) or a path to a snapshot file produced by dsc setting pull. Sources are detected by whether the argument refers to an existing file on disk; if not, it is treated as a Discourse name.

Fields

source: String

First source: Discourse name or snapshot file path.

target: String

Second source: Discourse name or snapshot file path.

changed_only: bool

Filter to settings where at least one source differs from default. Reduces noise when most settings on both sides are still default.

category: Option<String>

Limit to settings in this category (e.g. required, email). Only effective when both sources carry category metadata.

format: ListFormat

Output format.

Trait Implementations

impl FromArgMatches for SettingCommand

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 SettingCommand

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