en-US/about_Install-TechAgentRuntime.help.txt
|
# about_Install-TechAgentRuntime ## SHORT DESCRIPTION Verifies the local Ollama runtime and optionally pulls the configured Tech agent model. ## LONG DESCRIPTION Install-TechAgentRuntime now targets the packaged C# agent runtime used by Invoke-TechAgent. It no longer creates or repairs a repository-local Python virtual environment. Instead, it validates that Ollama is installed, reports which local models are available, and optionally pulls the configured model. ### What it does - Initializes the TechToolbox runtime via Initialize-TechToolboxRuntime. - Resolves the default model from settings.agent.model when -Model is not supplied. - Queries the local Ollama installation for currently available models. - Optionally pulls an Ollama model when -PullModel is specified. - Preserves legacy Python-related parameters for compatibility, but ignores them. - Returns a [PSCustomObject] summarising the Ollama runtime and model availability. ### Requirements - Ollama installed on PATH. ### Typical Usage Inspect the current Ollama runtime and configured model: ```powershell Install-TechAgentRuntime ``` Pull a specific model: ```powershell Install-TechAgentRuntime -PullModel -Model "qwen3.6:35b" ``` Call with a deprecated compatibility switch: ```powershell Install-TechAgentRuntime -PythonPath "C:\Python312\python.exe" ``` The command succeeds, but warns that the Python-related switch is ignored by the packaged C# agent runtime. ### Parameters - **PythonPath**: Deprecated compatibility parameter. Ignored. - **ForceRecreateVenv**: Deprecated compatibility parameter. Ignored. - **UpgradePip**: Deprecated compatibility parameter. Ignored. - **UpgradePackages**: Deprecated compatibility parameter. Ignored. - **PullModel**: When present, pulls an Ollama model after validating the local Ollama runtime. - **Model**: Specifies the Ollama model name to pull or inspect. If omitted, defaults to the value of settings.agent.model from the TechToolbox configuration. ### Return Value Returns a [PSCustomObject] with these properties: - **OllamaExecutable**: Full path to the resolved Ollama executable. - **Model**: The configured or requested model name. - **ModelPulled**: Boolean indicating whether a pull was requested. - **ModelAvailable**: Boolean indicating whether the selected model is available locally. - **AvailableModels**: Array of locally available Ollama model names. - **IgnoredCompatibilityParams**: Array of deprecated Python-related parameters that were supplied and ignored. - **Success**: Always $true when the command completes without error. ### Notes - This function depends on Initialize-TechToolboxRuntime and must be able to locate the TechToolbox module root and configuration. - If the Ollama executable is not found, an error is thrown. - If -PullModel is used without an explicit or configured model name, an error is thrown. - The command respects -WhatIf and -Confirm via SupportsShouldProcess for model pull operations. ## EXAMPLES ### Example 1: Default runtime validation ```powershell Install-TechAgentRuntime ``` Validates the local Ollama runtime and reports whether the configured default model is already available. ### Example 2: Pull a configured or explicit model ```powershell Install-TechAgentRuntime -PullModel -Model "qwen3.6:35b" ``` Pulls the specified Ollama model and then returns the updated list of available models. ## SEE ALSO - Invoke-TechAgent - Initialize-TechToolboxRuntime - Get-TechToolboxConfig ## KEYWORDS Install-TechAgentRuntime, TechAgent, Ollama, model, bootstrap, agent runtime, packaged agent |