Enum SourcesCommand 

pub enum SourcesCommand {
    List {
        verbose: bool,
        json: bool,
    },
    Add {
        url: String,
        name: Option<String>,
        preset: Option<String>,
        paths: Vec<String>,
        no_test: bool,
    },
    Remove {
        name: String,
        purge: bool,
        yes: bool,
    },
    Doctor {
        source: Option<String>,
        json: bool,
    },
    Sync {
        source: Option<Vec<String>>,
        no_index: bool,
        verbose: bool,
        dry_run: bool,
        json: bool,
    },
    ArtifactManifest {
        index_path: Option<PathBuf>,
        data_dir: Option<PathBuf>,
        write: bool,
        verify_existing: bool,
        expected_manifest: Option<PathBuf>,
        json: bool,
    },
    Mappings(MappingsAction),
    Agents(AgentsAction),
    Discover {
        preset: String,
        skip_existing: bool,
        json: bool,
    },
    Setup {
        dry_run: bool,
        non_interactive: bool,
        hosts: Option<Vec<String>>,
        skip_install: bool,
        skip_index: bool,
        skip_sync: bool,
        timeout: u64,
        resume: bool,
        verbose: bool,
        json: bool,
    },
}

Subcommands for managing remote sources (P5.x)

Variants

List

List configured sources

Fields

verbose: bool

Show detailed information

json: bool

Output as JSON (--robot also works)

Add

Add a new remote source

Fields

url: String

Source URL (e.g., user@host or ssh://user@host)

name: Option<String>

Friendly name for this source (becomes source_id)

preset: Option<String>

Use preset paths for platform (macos-defaults, linux-defaults)

paths: Vec<String>

Paths to sync (can be specified multiple times)

no_test: bool

Skip connectivity test

Remove

Remove a configured source

Fields

name: String

Name of source to remove

purge: bool

Also delete synced session data from index

yes: bool

Skip confirmation prompt

Doctor

Diagnose source connectivity and configuration issues

Fields

source: Option<String>

Check only specific source (defaults to all)

json: bool

Output as JSON (--robot also works)

Sync

Synchronize sessions from remote sources

Fields

source: Option<Vec<String>>

Sync only specific source(s)

no_index: bool

Don’t re-index after sync

verbose: bool

Show detailed transfer information

dry_run: bool

Dry run - show what would be synced without actually syncing

json: bool

Output as JSON (--robot also works)

ArtifactManifest

Build or write a lexical artifact evidence manifest for remote exchange

Fields

index_path: Option<PathBuf>

Exact lexical index path. Defaults to /index/.

data_dir: Option<PathBuf>

Override cass data dir used to resolve the lexical index path

write: bool

Write evidence-bundle-manifest.json next to the lexical artifact

verify_existing: bool

Verify the existing evidence-bundle-manifest.json without regenerating it

expected_manifest: Option<PathBuf>

Producer manifest to compare against when verifying a copied artifact

json: bool

Output as JSON (--robot also works)

Mappings(MappingsAction)

Manage path mappings for a source (P6.3)

Agents(AgentsAction)

Manage persisted agent indexing exclusions

Discover

Auto-discover SSH hosts from ~/.ssh/config

Fields

preset: String

Platform preset for default paths (macos-defaults, linux-defaults)

skip_existing: bool

Skip hosts that are already configured as sources

json: bool

Output as JSON (--robot also works)

Setup

Interactive wizard to discover, configure, and set up remote sources.

This wizard automates configuring cass to search across multiple machines. It discovers SSH hosts from ~/.ssh/config, checks each for existing cass installations and agent session data, then guides you through selecting which machines to configure for remote search.

Workflow Phases

1. Discovery: Parses ~/.ssh/config to find configured hosts
2. Probing: Connects to each host via SSH to check cass status and data
3. Selection: Interactive selection of which hosts to configure
4. Installation: Installs cass on hosts that don’t have it (optional)
5. Indexing: Runs cass index on remotes (optional)
6. Configuration: Generates and saves sources.toml entries
7. Sync: Downloads session data to local machine (optional)

Examples

# Interactive wizard (recommended for first-time setup)
cass sources setup

# Configure specific hosts only
cass sources setup --hosts css,csd,yto

# Preview without making changes
cass sources setup --dry-run

# Resume an interrupted setup
cass sources setup --resume

# Non-interactive for scripting (uses auto-detected defaults)
cass sources setup --non-interactive --hosts css,csd

# Skip installation and indexing, just configure
cass sources setup --hosts css --skip-install --skip-index

# JSON output for automation
cass sources setup --json --hosts css

State and Resume

If setup is interrupted (Ctrl+C, connection lost), state is saved to ~/.cache/cass/setup_state.json. Resume with cass sources setup --resume.

See Also

• cass sources list - List configured sources
• cass sources sync - Sync data from sources
• cass sources discover - Just discover hosts (no setup)
• cass robot-docs sources - Machine-readable sources documentation

Fields

dry_run: bool

Preview what would happen without making changes

non_interactive: bool

Skip interactive prompts (use auto-detected defaults for scripting)

hosts: Option<Vec<String>>

Configure only these hosts (comma-separated SSH aliases, skips discovery/selection)

skip_install: bool

Skip cass installation on remotes that don’t have it

skip_index: bool

Skip running cass index on remotes

skip_sync: bool

Skip syncing data after setup completes

timeout: u64

SSH connection timeout in seconds

resume: bool

Resume from previous interrupted setup (reads ~/.cache/cass/setup_state.json)

verbose: bool

Show detailed progress output

json: bool

Output progress as JSON (implies non-interactive, for scripting)

Trait Implementations

impl Clone for SourcesCommand

fn clone(&self) -> SourcesCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SourcesCommand

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

Formats the value using the given formatter.

impl FromArgMatches for SourcesCommand

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 SourcesCommand

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