Enum Commands 

pub enum Commands {
    Add {
        target: String,
        alias: Option<String>,
        key: Option<String>,
    },
    Import {
        file: Option<String>,
        known_hosts: bool,
        group: Option<String>,
    },
    Sync {
        provider: Option<String>,
        dry_run: bool,
        remove: bool,
    },
    Provider {
        command: ProviderCommands,
    },
    Tunnel {
        command: TunnelCommands,
    },
    Password {
        command: PasswordCommands,
    },
    Snippet {
        command: SnippetCommands,
    },
    Update,
    Mcp {
        read_only: bool,
        no_audit: bool,
        audit_log: Option<String>,
    },
    Theme {
        command: ThemeCommands,
    },
    Vault {
        command: VaultCommands,
    },
    Logs {
        tail: bool,
        clear: bool,
    },
    WhatsNew {
        since: Option<String>,
    },
}

Variants

Add

Quick-add a host: purple add user@host:port –alias myserver

Fields

target: String

Target in user@hostname:port format

alias: Option<String>

Alias for the host (default: derived from hostname)

key: Option<String>

Path to identity file (SSH key)

Import

Import hosts from a file or known_hosts

Fields

file: Option<String>

File with one host per line (user@host:port format)

known_hosts: bool

Import from ~/.ssh/known_hosts instead

group: Option<String>

Group label for imported hosts

Sync

Sync hosts from cloud providers (DigitalOcean, Vultr, Linode, Hetzner, UpCloud, Proxmox VE, AWS EC2, Scaleway, GCP, Azure, Tailscale, Oracle Cloud, OVHcloud, Leaseweb, i3D.net, TransIP)

Fields

provider: Option<String>

Sync a specific provider (default: all configured)

dry_run: bool

Preview changes without modifying config

remove: bool

Remove hosts that no longer exist on the provider

Provider

Manage cloud provider configurations

Fields

command: ProviderCommands

Tunnel

Manage SSH tunnels

Fields

command: TunnelCommands

Password

Manage passwords in the OS keychain for SSH hosts

Fields

command: PasswordCommands

Snippet

Manage command snippets for quick execution on hosts

Fields

command: SnippetCommands

Update

Update purple to the latest version

Mcp

Start MCP server (Model Context Protocol) for AI agent integration

Fields

read_only: bool

Restrict tools to read-only operations. Denies run_command and container_action, and removes them from tools/list. Recommended when exposing purple to autonomous agents.

no_audit: bool

Disable the MCP audit log. By default every tool call is appended to ~/.purple/mcp-audit.log as JSON Lines.

audit_log: Option<String>

Custom path for the MCP audit log (default: ~/.purple/mcp-audit.log). Ignored when –no-audit is set.

Theme

Manage color themes

Fields

command: ThemeCommands

Vault

HashiCorp Vault SSH secrets engine operations (signed SSH certificates)

Fields

command: VaultCommands

Logs

View or manage log file

Fields

tail: bool

Follow log output in real time

clear: bool

Delete the log file

WhatsNew

Print release notes since a prior version

Fields

since: Option<String>

Only include entries newer than this version (e.g. 2.40.0)

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