Enum Command 

pub enum Command {
    Add {
        id: Option<String>,
        uri: Option<String>,
        ref_or_rev: Option<String>,
        no_flake: bool,
        shallow: bool,
    },
    Remove {
        id: Option<String>,
    },
    Change {
        id: Option<String>,
        uri: Option<String>,
        ref_or_rev: Option<String>,
        shallow: bool,
    },
    List {
        format: ListFormat,
    },
    Update {
        id: Option<String>,
        init: bool,
    },
    Pin {
        id: Option<String>,
        rev: Option<String>,
    },
    Unpin {
        id: Option<String>,
    },
    Follow {
        paths: Vec<PathBuf>,
    },
    AddFollow {
        input: Option<String>,
        target: Option<String>,
    },
    Completion {
        inputs: bool,
        mode: CompletionMode,
    },
    Config {
        print_default: bool,
        path: bool,
    },
}

Variants

Add

Add a new flake reference.

Fields

id: Option<String>

The name of an input attribute.

uri: Option<String>

The uri that should be added to the input.

ref_or_rev: Option<String>

Pin to a specific ref_or_rev

no_flake: bool

The input itself is not a flake.

shallow: bool

Use shallow clone for the input.

Remove

Remove a specific flake reference based on its id.

Fields

id: Option<String>

Change

Change an existing flake reference’s URI.

Fields

id: Option<String>

The name of an existing input attribute.

uri: Option<String>

The new URI for the input.

ref_or_rev: Option<String>

Pin to a specific ref_or_rev

shallow: bool

Use shallow clone for the input.

List

List flake inputs

Fields

format: ListFormat

Update

Update inputs to their latest specified release.

Fields

id: Option<String>

The id of an input attribute. If omitted will update all inputs.

init: bool

Whether the latest semver release of the remote should be used even thought the release itself isn’t yet pinned to a specific release.

Pin

Pin inputs to their current or a specified rev.

Fields

id: Option<String>

The id of an input attribute.

rev: Option<String>

Optionally specify a rev for the inputs attribute.

Unpin

Unpin an input so it tracks the upstream default again.

Fields

id: Option<String>

The id of an input attribute.

Follow

Automatically add and remove follows declarations.

Analyzes the flake.lock to find nested inputs that match top-level inputs, then adds appropriate follows declarations and removes stale ones.

With file paths, processes multiple flakes in batch. For every flake.nix file passed in it will assume a flake.lock file exists in the same directory.

Fields

paths: Vec<PathBuf>

Flake.nix paths to process. If empty, runs on current directory.

AddFollow

Manually add a single follows declaration.

Example: flake-edit add-follow rust-overlay.nixpkgs nixpkgs

This creates: rust-overlay.inputs.nixpkgs.follows = "nixpkgs";

Without arguments, starts an interactive selection.

Fields

input: Option<String>

The input path in dot notation (e.g., “rust-overlay.nixpkgs” means the nixpkgs input of rust-overlay).

target: Option<String>

The target input to follow (e.g., “nixpkgs”).

Completion

Meant for shell completions.

Fields

inputs: bool

mode: CompletionMode

Config

Manage flake-edit configuration.

Fields

print_default: bool

Output the default configuration to stdout.

path: bool

Show where configuration would be loaded from.

Trait Implementations

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Command

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