Struct App 

pub struct App { /* private fields */ }

Top-level application orchestrator.

Implementations

impl App

pub fn from_env() -> Result<Self, CoreError>

Creates an application from the process environment.

pub fn new( home_layout: HomeLayout, cwd: PathBuf, session_id: Option<String>, ) -> Result<Self, CoreError>

Creates an application with explicit paths.

impl App

pub fn activate(&self, shell: &str) -> Result<String, CoreError>

Renders an activation script for the selected shell.

impl App

pub fn add_plugin( &self, name: Option<&str>, source: Option<String>, backend: Option<PluginBackendKind>, alias: Option<&str>, ) -> Result<RegistryEntry, CoreError>

Adds a plugin to the local home.

impl App

pub fn available_plugins(&self) -> Result<Vec<RegistryEntry>, CoreError>

Lists plugins in the available registry index.

pub fn added_plugins(&self) -> Result<Vec<RegistryEntry>, CoreError>

Lists plugins added to the local home.

impl App

pub fn home_dir(&self) -> String

Returns the active home directory path.

pub fn cd_path(&self, plugin_name: &str) -> Result<String, CoreError>

Prints the active runtime directory for a tool.

pub fn plugin_dir(&self, plugin_name: &str) -> Result<String, CoreError>

Returns the local plugin source directory.

impl App

pub fn cleanup_session(&self) -> Result<(), CoreError>

Removes the session tools file for the current session.

Called by the shell EXIT trap via vs __cleanup-session so that the home directory is resolved at runtime rather than hardcoded in the activation script.

pub fn cleanup_stale_sessions(&self) -> Result<(), CoreError>

Removes session files for processes that no longer exist.

Called during activation for shells that lack an EXIT trap (nushell, clink) via vs __cleanup-stale-sessions.

impl App

pub fn list_config(&self) -> Result<Vec<(String, String)>, CoreError>

Lists current application config values.

pub fn config_value(&self) -> Result<Value, CoreError>

Returns the whole config as a YAML-like value.

pub fn config_entries_for_key( &self, key: &str, ) -> Result<Vec<(String, String)>, CoreError>

Returns config entries for an exact key or section prefix.

pub fn set_config_value(&self, key: &str, value: &str) -> Result<(), CoreError>

Sets a config key.

pub fn unset_config_value(&self, key: &str) -> Result<(), CoreError>

Unsets a config key.

impl App

pub fn current_tool( &self, plugin_name: &str, ) -> Result<Option<CurrentTool>, CoreError>

Resolves the active version for a specific plugin.

pub fn current_tools(&self) -> Result<Vec<CurrentTool>, CoreError>

Resolves all active tools for the current context.

pub fn current_tool_statuses( &self, ) -> Result<Vec<(String, Option<String>)>, CoreError>

Returns all known plugins with their current version when available.

impl App

pub fn exec( &self, plugin_name: &str, requested_version: Option<&str>, command: &str, args: &[String], ) -> Result<i32, CoreError>

Executes a command with the resolved runtime environment for a specific SDK.

impl App

pub fn hook_env(&self, shell: &str) -> Result<String, CoreError>

Renders hidden shell hook output.

impl App

pub fn plugin_info(&self, name: &str) -> Result<PluginInfo, CoreError>

Loads registry and backend metadata for a plugin.

pub fn plugin_runtime_path( &self, plugin_name: &str, version: &str, ) -> Result<Option<PathBuf>, CoreError>

Returns the installed runtime path for a specific plugin version.

impl App

pub fn install_plugin_version( &self, plugin_name: &str, version: Option<&str>, ) -> Result<InstalledVersion, CoreError>

Installs a plugin version, choosing the first available version when omitted.

pub fn project_tool_version( &self, plugin_name: &str, ) -> Result<Option<String>, CoreError>

Returns the version requested by the project config for a plugin, when present.

pub fn configured_tools_for_install( &self, ) -> Result<Vec<(String, String)>, CoreError>

Lists configured tools that should be installed for the current context.

impl App

pub fn list_installed_versions( &self, ) -> Result<Vec<InstalledVersion>, CoreError>

Lists installed tool versions in the local cache.

impl App

pub fn migrate( &self, source: Option<String>, ) -> Result<MigrateSummary, CoreError>

Copies compatible state from a legacy home into the active home.

impl App

pub fn remove_plugin(&self, name: &str) -> Result<bool, CoreError>

Removes a plugin, its source directory, and all installed SDK versions.

impl App

pub fn search_versions( &self, plugin_name: &str, args: &[String], ) -> Result<Vec<AvailableVersion>, CoreError>

Lists available SDK versions for a plugin.

impl App

pub fn uninstall_plugin_version( &self, plugin_name: &str, version: &str, ) -> Result<UninstallResult, CoreError>

Uninstalls a plugin version from the local cache.

When the uninstalled version is currently active and other versions remain, auto-switches to the first remaining version (global scope). When no versions remain, removes the entire plugin cache directory.

impl App

pub fn unuse_tool( &self, plugin_name: &str, scope: UseScope, ) -> Result<(), CoreError>

Removes an active tool version from the selected scope.

impl App

pub fn update_registry(&self) -> Result<usize, CoreError>

Refreshes the searchable plugin index from the configured registry source.

pub fn update_plugin(&self, name: &str) -> Result<RegistryEntry, CoreError>

Updates a locally added plugin from its manifest URL or registry metadata.

pub fn update_all_plugins(&self) -> Result<Vec<RegistryEntry>, CoreError>

Updates every locally added plugin.

impl App

pub fn self_upgrade_summary(&self) -> Result<SelfUpgradeSummary, CoreError>

Returns the current and latest available self-upgrade versions.

pub fn upgrade_self_to( &self, latest_version: &str, ) -> Result<SelfUpgradeSummary, CoreError>

Upgrades the running vs binary to the provided published release version.

impl App

pub fn use_tool( &self, plugin_name: &str, version: &str, scope: UseScope, unlink: bool, ) -> Result<InstalledVersion, CoreError>

Activates an installed tool version for a given scope.

pub fn project_tool_version_for_use( &self, plugin_name: &str, ) -> Result<Option<String>, CoreError>

Resolves the version from the project config file when no version is specified on the CLI (empty string). Returns None when no project config is found.

pub fn installed_versions_for_plugin( &self, plugin_name: &str, ) -> Result<Vec<InstalledVersion>, CoreError>

Returns installed versions for a single plugin, sorted from newest-looking to oldest-looking.

impl App

pub fn version_info(&self) -> Result<VersionInfo, CoreError>

Returns version and build metadata for the current binary.

Trait Implementations

impl Clone for App

fn clone(&self) -> App

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for App

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

Formats the value using the given formatter.