Struct SshConfig 

pub struct SshConfig {

    pub password: Option<String>,
    pub username: Option<String>,
    pub host: Option<String>,
    pub project_dir: Option<String>,
    pub xbp_api_token: Option<String>,
    pub openrouter_api_key: Option<String>,
    pub github_oauth2_key: Option<String>,
    pub cloudflare_api_token: Option<String>,
    pub cloudflare_user_api_token: Option<String>,
    pub cloudflare_account_api_token: Option<String>,
    pub cloudflare_account_id: Option<String>,
    pub linear_api_key: Option<String>,
    pub npm_token: Option<String>,
    pub crates_token: Option<String>,
    pub openrouter: OpenRouterConfig,
    pub linear: Option<LinearConfig>,
    pub cli_auth: Option<CliAuthState>,
    pub device: Option<DeviceIdentity>,
    pub secret_metadata: BTreeMap<String, SecretMetadata>,
    pub system_inventory: Option<SystemInventory>,
    pub cursor_ingest: Option<CursorIngestState>,
    pub system_inventory_refresh: Option<SystemInventoryRefreshState>,
    pub dns_inventory: Option<DnsInventoryCache>,
    pub runners: Option<RunnerMachineConfig>,
    pub worktree_watch: Option<WorktreeWatchConfig>,
    pub issues: Option<TodosConfig>,
    pub todos: Option<TodosConfig>,
    pub discord: Option<DiscordConfig>,
    pub oci: Option<GlobalOciConfig>,
}

Fields

password: Option<String>

username: Option<String>

host: Option<String>

project_dir: Option<String>

xbp_api_token: Option<String>

openrouter_api_key: Option<String>

github_oauth2_key: Option<String>

cloudflare_api_token: Option<String>

Primary / default Cloudflare API token (legacy single slot; still used by Wrangler).

cloudflare_user_api_token: Option<String>

User API token (cfut_…). Required for Workers Builds; also fine for Wrangler.

cloudflare_account_api_token: Option<String>

Account-owned API token (cfat_…). OK for Wrangler/deploy; not accepted by Workers Builds yet.

cloudflare_account_id: Option<String>

linear_api_key: Option<String>

npm_token: Option<String>

crates_token: Option<String>

openrouter: OpenRouterConfig

linear: Option<LinearConfig>

cli_auth: Option<CliAuthState>

device: Option<DeviceIdentity>

secret_metadata: BTreeMap<String, SecretMetadata>

system_inventory: Option<SystemInventory>

cursor_ingest: Option<CursorIngestState>

system_inventory_refresh: Option<SystemInventoryRefreshState>

dns_inventory: Option<DnsInventoryCache>

runners: Option<RunnerMachineConfig>

worktree_watch: Option<WorktreeWatchConfig>

Client-side worktree-watch path filters (paths, folders, banned words).

issues: Option<TodosConfig>

Defaults for xbp issues automation (overridden by project config issues:).

todos: Option<TodosConfig>

Deprecated defaults for xbp todos automation. Read as fallback for issues:.

discord: Option<DiscordConfig>

Global Discord webhook defaults (overridden by project .xbp/xbp.toml / project config discord:).

oci: Option<GlobalOciConfig>

Global OCI registry credentials (tokens never printed by default).

Implementations

impl SshConfig

pub fn new() -> Self

pub fn worktree_watch_config(&self) -> WorktreeWatchConfig

Load worktree-watch ignore rules from the global config (client-side only).

pub fn get_secret(&self, provider: SecretProvider) -> Option<&str>

pub fn set_secret(&mut self, provider: SecretProvider, value: Option<String>)

pub fn get_secret_metadata( &self, provider: SecretProvider, ) -> Option<&SecretMetadata>

pub fn load() -> Result<Self, String>

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

impl SshConfig

pub fn cloudflare_user_api_token(&self) -> Option<&str>

pub fn cloudflare_account_api_token(&self) -> Option<&str>

pub fn cloudflare_primary_api_token(&self) -> Option<&str>

pub fn store_cloudflare_token( &mut self, token: impl Into<String>, slot: CloudflareTokenSlot, ) -> Result<CloudflareTokenStoreReport, String>

Store a token in the right slot(s). Primary is updated when it is empty or matches the same kind being written, so Wrangler keeps a sensible default.

pub fn clear_cloudflare_token_slot( &mut self, slot: CloudflareTokenSlot, ) -> Vec<&'static str>

Delete one or all Cloudflare token slots.

pub fn cloudflare_config_token_entries(&self) -> Vec<(String, String)>

Configured Cloudflare tokens as (source label, token), kind-specific first.

Trait Implementations

impl Clone for SshConfig

fn clone(&self) -> SshConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SshConfig

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

Formats the value using the given formatter.

impl Default for SshConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SshConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SshConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.