Loading

Namespace options

Scoped to a namespace and its children. Namespace options extend the shared state model beyond global options for hierarchical CLIs.

public record StorageOptions(string ConnectionString = "") : GlobalOptions;

app.MapNamespace<StorageHandlers>("storage", ns =>
{
    ns.UseNamespaceOptions<StorageOptions>();
    ns.Map("list", (StorageOptions o) => { … });
});

Running myapp storage list --connection-string "…" --verbose applies both the namespace and global flags.

The options type must inherit the parent's options type - GlobalOptions at the root, or the enclosing namespace's options further down.

Warning

The generator reports an error (AGH0004) if the inheritance chain is broken. Each namespace options type must extend its parent's options type.

public record GlobalOptions(bool Verbose = false);
public record StorageOptions(string ConnectionString = "") : GlobalOptions;
public record BlobOptions(string Container = "") : StorageOptions;

app.UseGlobalOptions<GlobalOptions>();
app.MapNamespace<StorageHandlers>("storage", ns =>
{
    ns.UseNamespaceOptions<StorageOptions>();
    ns.MapNamespace<BlobHandlers>("blob", blob =>
    {
        blob.UseNamespaceOptions<BlobOptions>();
    });
});
Note

In generated code, parsing follows this order: globals → namespace options along the path → command flags and positionals.

Commands under a namespace are required to declare the namespace options type as a parameter. This is enforced by analyzer AGH0021.

Annotate the method with [NoOptionsInjection] to opt out.

public record DeployOptions(string Environment, bool DryRun = false) : StorageOptions;

ns.Map("deploy", ([AsParameters] DeployOptions opts) => { … });

Running myapp storage deploy --connection-string "…" --environment staging --dry-run passes all inherited and local flags.