Struct Config 

pub struct Config {
    pub bird_root: PathBuf,
    pub client_id: String,
    pub hot_days: u32,
    pub inline_threshold: usize,
    pub auto_extract: bool,
    pub storage_mode: StorageMode,
    pub remotes: Vec<RemoteConfig>,
    pub sync: SyncConfig,
    pub hooks: HooksConfig,
    pub buffer: BufferConfig,
}

BIRD configuration.

Fields

bird_root: PathBuf

Root directory for all BIRD data.

client_id: String

Client identifier for this machine.

hot_days: u32

Days to keep data in hot tier before archiving.

inline_threshold: usize

Threshold in bytes for inline vs blob storage.

auto_extract: bool

Automatically extract events after shq run commands.

storage_mode: StorageMode

Storage mode for writing data.

• parquet: Multi-writer safe, requires compaction (default)
• duckdb: Single-writer, no compaction needed

remotes: Vec<RemoteConfig>

Remote storage configurations.

sync: SyncConfig

Sync configuration for push/pull operations.

hooks: HooksConfig

Shell hook configuration.

buffer: BufferConfig

Retrospective buffer configuration.

Implementations

impl Config

pub fn with_root(bird_root: impl Into<PathBuf>) -> Self

Create a new config with the given BIRD_ROOT.

pub fn with_duckdb_mode(bird_root: impl Into<PathBuf>) -> Self

Create a new config with DuckDB storage mode.

pub fn default_location() -> Result<Self>

Create a config using default BIRD_ROOT resolution.

pub fn load() -> Result<Self>

Load config from BIRD_ROOT/config.toml, or create default.

pub fn load_from(bird_root: &Path) -> Result<Self>

Load config from a specific BIRD_ROOT.

pub fn save(&self) -> Result<()>

Save config to BIRD_ROOT/config.toml.

pub fn db_path(&self) -> PathBuf

Path to the DuckDB database file.

pub fn data_dir(&self) -> PathBuf

Path to the data directory.

pub fn recent_dir(&self) -> PathBuf

Path to the recent (hot) data directory.

pub fn archive_dir(&self) -> PathBuf

Path to the archive (cold) data directory.

pub fn attempts_dir(&self, date: &NaiveDate) -> PathBuf

Path to attempts parquet files for a given date (v5 schema).

Partitioning: recent/attempts/date=YYYY-MM-DD/

pub fn outcomes_dir(&self, date: &NaiveDate) -> PathBuf

Path to outcomes parquet files for a given date (v5 schema).

Partitioning: recent/outcomes/date=YYYY-MM-DD/

pub fn invocations_dir_with_status( &self, status: &str, date: &NaiveDate, ) -> PathBuf

Path to invocations parquet files for a given date and status.

V4 Schema: Status partitioning: recent/invocations/status=<status>/date=YYYY-MM-DD/

In v5 schema, use attempts_dir() and outcomes_dir() instead.

pub fn invocations_dir(&self, date: &NaiveDate) -> PathBuf

Path to invocations parquet files for a given date (defaults to “completed” status).

V4 Schema: For backwards compatibility - use invocations_dir_with_status for explicit status.

In v5 schema, use attempts_dir() and outcomes_dir() instead.

pub fn pending_dir(&self) -> PathBuf

👎Deprecated since 0.2.0: V4 schema. In v5, pending detection is via the invocations view.

Path to the pending invocations directory (JSON files for crash recovery).

V4 Schema: In v5, pending detection is via: SELECT * FROM attempts WHERE id NOT IN (SELECT attempt_id FROM outcomes)

pub fn outputs_dir(&self, date: &NaiveDate) -> PathBuf

Path to outputs parquet files for a given date.

pub fn sessions_dir(&self, date: &NaiveDate) -> PathBuf

Path to sessions parquet files for a given date.

pub fn sql_dir(&self) -> PathBuf

Path to the SQL files directory.

pub fn extensions_dir(&self) -> PathBuf

Path to the DuckDB extensions directory.

pub fn blobs_dir(&self) -> PathBuf

Path to the blobs content directory.

pub fn running_dir(&self) -> PathBuf

Path to the running directory for in-progress command output.

Files here are temp files streamed during command execution: running/<invocation_id>.out

On completion, content is moved to blob storage. On crash, files survive for recovery. Use shq show --follow <id> to tail while running.

pub fn running_path(&self, invocation_id: &Uuid) -> PathBuf

Path to a running output file for a specific invocation.

pub fn buffer_dir(&self) -> PathBuf

Path to the retrospective buffer directory.

Contains output from recent shell commands that weren’t explicitly captured. Files: <uuid>.out (output) and <uuid>.meta (JSON metadata). Protected with 700 permissions since buffer may contain sensitive output.

pub fn buffer_output_path(&self, id: &Uuid) -> PathBuf

Path to a buffer entry’s output file.

pub fn buffer_meta_path(&self, id: &Uuid) -> PathBuf

Path to a buffer entry’s metadata file.

pub fn blob_path(&self, hash: &str, cmd_hint: &str) -> PathBuf

Path to a specific blob file by hash and command.

pub fn event_formats_path(&self) -> PathBuf

Path to the event-formats.toml config file (legacy).

pub fn format_hints_path(&self) -> PathBuf

Path to the format-hints.toml config file.

pub fn events_dir(&self, date: &NaiveDate) -> PathBuf

Path to events parquet files for a given date.

pub fn get_remote(&self, name: &str) -> Option<&RemoteConfig>

Get a remote by name.

pub fn add_remote(&mut self, remote: RemoteConfig)

Add a remote configuration.

pub fn remove_remote(&mut self, name: &str) -> bool

Remove a remote by name. Returns true if removed.

pub fn blob_roots(&self) -> Vec<String>

Get all blob roots for multi-location resolution. Returns local blobs dir first, then remote blob URLs.

pub fn auto_attach_remotes(&self) -> Vec<&RemoteConfig>

Get remotes that should be auto-attached.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.