Skip to main content

Module setup

Module setup 

Source
Expand description

Additive first-run discovery shared by the dashboard and mj setup.

Structs§

DiscoveredHome
GithubRepository
RuntimeProbe
SetupReport

Enums§

RuntimeKind

Constants§

DEFAULT_IMAGE
The container image a session uses when its target names none.

Functions§

actionable_errors
Welcome displays errors and concrete remedies, without successful checks or warnings about optional built-in runtimes and background image downloads.
add_detected_profiles
Adds a profile for every agent installed since the configuration was last written, the same additive merge as Settings’ Detect profiles. Each launch of an existing installation runs this, so a newly installed agent appears without a trip to Settings. This runs on every launch by the user’s decision; a removed profile for an installed agent returns, exactly as it does from Settings’ Detect profiles, and disabling the profile is how a user stops using an agent. Returns the identifiers it added.
build_config
Configuration additions for installed profiles and the current repository.
discover_profiles
The installed agent homes alone. Callers that only add profiles use this without probing unrelated runtimes or remote targets.
discover_runtimes
The container runtimes on this machine alone, usable or not, so a caller can report why an unusable one was skipped.
discover_ssh_hosts
Read the concrete Host aliases from ~/.ssh/config.
github_repository_from_origin
local_runtime_target
The shared setup/startup template for a locally available container engine.
probe_local_runtimes
Probe the container runtimes setup can configure, reusing the doctor checks so an unavailable runtime carries doctor’s detail and remediation.
profiles_config
A configuration holding the discovered profiles and nothing else, for merging into an existing configuration.
run_setup
Returns None when automatic setup belongs to an existing installation. The accepted callback runs under the setup lock, before discovery starts.
run_setup_command
ssh_config_aliases
Extract the usable Host aliases from SSH config text.