Skip to main content

Module config

Module config 

Source
Expand description

Configuration types for remote sources.

This module defines the data structures for configuring remote sources that cass can sync agent sessions from. Configuration is stored in TOML format at ~/.config/cass/sources.toml (or XDG equivalent).

§Example Configuration

[[sources]]
name = "laptop"
type = "ssh"
host = "user@laptop.local"
paths = ["~/.claude/projects", "~/.cursor"]
sync_schedule = "manual"

[[sources]]
name = "workstation"
type = "ssh"
host = "user@work.example.com"
paths = ["~/.claude/projects"]
sync_schedule = "daily"

# Path mappings rewrite remote paths to local equivalents
[[sources.path_mappings]]
from = "/home/user/projects"
to = "/Users/me/projects"

# Agent-specific mappings only apply when viewing specific agent sessions
[[sources.path_mappings]]
from = "/opt/work"
to = "/Volumes/Work"
agents = ["claude-code"]

# Disable noisy connectors globally, including the built-in local source.
disabled_agents = ["openclaw"]

Structs§

BackupInfo
Information about a backup created before config modification.
ConfigPreview
Preview of configuration changes before writing.
DiscoveredHost
Discovered SSH host from ~/.ssh/config
PathMapping
A single path mapping rule for rewriting paths.
SourceConfigGenerator
Generator for creating source configurations from probe results.
SourceDefinition
Definition of a single source (local or remote).
SourcesConfig
Root configuration containing all source definitions.

Enums§

ConfigError
Errors that can occur when loading or saving source configuration.
MergeResult
Result of merging a source into existing configuration.
Platform
Platform hint for choosing default paths.
SkipReason
Reason why a source was skipped during config generation.
SyncSchedule
Sync schedule for remote sources.

Functions§

discover_ssh_hosts
Discover SSH hosts from ~/.ssh/config.
get_preset_paths
Get preset paths for a given platform.