en-US/about_PSAITerminal.help.txt
|
TOPIC about_PSAITerminal SHORT DESCRIPTION Use local AI chat, command assistance, and multi-step Agent features in official PowerShell. PLATFORMS Windows PowerShell 5.1 (x64/x86) and PowerShell 7.4 or later on Windows. Linux and macOS are unsupported; their implementations have been removed. GETTING STARTED Type ai and press Enter to open settings, add a model, and select it. Type ai <question> to ask the active model explicitly in any mode. MODES Off Enter always executes PowerShell normally. AI Natural language is routed to AI; valid Shell input keeps its execution path. Auto Deterministic PowerShell commands run directly; natural-language or failed commands go to AI. LANGUAGE The default interface language is English. Type ai, select Language / 语言, and choose English or Chinese (简体中文). The choice is persisted. SHORTCUTS F2 Send the current input to AI without pressing Enter first. F3 Execute the current input as PowerShell without pressing Enter first. F6 Cycle Off, AI, and Auto. F7 Explain the most recent command and its result. On some laptops, hold Fn together with the function key. Windows PowerShell 5.1 does not expose the PowerShell 7 predictor and feedback APIs; diagnostics report them as unsupported while all other features remain available. DIAGNOSTICS Test-PSAIConfiguration checks installation, configuration, credentials, endpoint, PSReadLine, and shortcut integration. Test-PSAIConfiguration -Online sends one minimal model request after local checks. CREDENTIALS API keys are stored in Windows Credential Manager and are not written to JSON. The module first requests machine persistence. In a restricted logon session where Windows returns ERROR_NO_SUCH_LOGON_SESSION (1312), it safely uses a credential scoped to the current logon session instead; it never falls back to plaintext. COMMON COMMANDS Get-PSAIModel Get-PSAISession Get-PSAIRun Set-PSAITerminalMode Off|AI|Auto Uninstall-PSAITerminal SAFETY CONFIRMATION AI-generated purpose, expected-result, and side-effect descriptions may be inaccurate. Treat the complete command shown on the approval screen as authoritative. High-risk commands have no Enter-to-execute default and require a second confirmation. All risk levels display purpose, command, expected result, side effects, rollback, and local risk. Approval binds the command, descriptions, plan progression, and Run revision. Editing revokes approval and regenerates four descriptions without tools. Invalid or failed descriptions block approval; edit again or reject. Model-provided risk is not trusted. Rollback text is AI-generated guidance; the module does not automatically back up, undo, or restore system state. Commands run with the current user's permissions in the current PowerShell session, not a sandbox. RELIABILITY (1.0.4) Consultation requests have no tools. Ambiguous input asks for a complete new request locally. Structured plans determine completion, not task keywords. A successful final step completes without another model request; intermediate steps continue with actual output. Reserve a verification step if the final artifact still needs checking. F7 explains only on request. Run v2 persists the plan, completion condition, step role, result, and Normal/Cleanup/Retry phase. Cleanup success returns to the original step. Cleanup failure pauses until explicit resume. Every cleanup and retry needs approval and counts toward the step limit. No guaranteed recovery or exhaustive side-effect detection is provided. Failed commands display failure, not completion. Completed legacy Runs remain readable. Unfinished legacy Runs must replan and reapprove. Uncertain executions require Resolve-PSAIRun before resuming; they are never automatically replayed. NOTES No model is bundled. The first installation starts in Off mode and does not connect automatically. Packages are not Authenticode-signed. For manual installation, verify the SHA-256 published with the official GitHub Release. API keys are never written to JSON. Windows uses Credential Manager. If the platform store is unavailable, SessionOnly can be selected. |