diff --git a/reference/docs-conceptual/AIShell/developer/agent-architecture.md b/reference/docs-conceptual/AIShell/developer/agent-architecture.md index 61cabbf..8d16ef2 100644 --- a/reference/docs-conceptual/AIShell/developer/agent-architecture.md +++ b/reference/docs-conceptual/AIShell/developer/agent-architecture.md @@ -40,7 +40,7 @@ An agent plugin is responsible for managing its own chat history. This is the implementation of AI Shell. It consists of the following components: - ReadLine -- Renders (mardown render, stream render, paging render) +- Renders (markdown render, stream render, paging render) - Plugin management - Host (a range of utility methods for writing output and interactive prompting) - Command runner and built-in commands diff --git a/reference/docs-conceptual/AIShell/developer/create-ollama-agent.md b/reference/docs-conceptual/AIShell/developer/create-ollama-agent.md index 45a49ca..8395f73 100644 --- a/reference/docs-conceptual/AIShell/developer/create-ollama-agent.md +++ b/reference/docs-conceptual/AIShell/developer/create-ollama-agent.md @@ -41,7 +41,7 @@ First step is to create a new classlib project. ### Step 2: Add the necessary packages Within the newly created project, you need to install the [AIShell.Abstraction][06] package from the -Nuget gallery. Install the Nuget package using the following command: +NuGet gallery. Install the NuGet package using the following command: ```shell dotnet add package AIShell.Abstraction --version 1.0.0-preview.1 @@ -66,7 +66,7 @@ following XML: ``` > [!IMPORTANT] -> Be sure to check you are on the latest version from the Nuget gallery. +> Be sure to check you are on the latest version from the NuGet gallery. ### Step 3: Implement the agent class @@ -205,7 +205,7 @@ public sealed class OllamaAgent : ILLMAgent ``` For the initial implementation, the agent to returns "Hello World!" to prove that you created the -correct interfaces. You will also add a `try-catch` block to catch and handle any expections when +correct interfaces. You will also add a `try-catch` block to catch and handle any exceptions when the user tries to cancel the operation. Add the following code to your `Chat` method. @@ -499,4 +499,4 @@ in the `agents` folder of the base directory of `aish.exe`, the agent will be lo [03]: https://github.com/PowerShell/ProjectMercury/discussions/categories/agent-sharing [04]: https://github.com/PowerShell/ProjectMercury/shell/agents/AIShell.Ollama.Agent [05]: https://github.com/PowerShell/ProjectMercury/shell/README.md -[06]: https://www.nuget.org/packages/AIShell.Abstraction/1.0.0-preview.1 \ No newline at end of file +[06]: https://www.nuget.org/packages/AIShell.Abstraction/1.0.0-preview.1 diff --git a/reference/docs-conceptual/AIShell/how-to/aishell-reference.md b/reference/docs-conceptual/AIShell/how-to/aishell-reference.md index c940f0c..cdb07ff 100644 --- a/reference/docs-conceptual/AIShell/how-to/aishell-reference.md +++ b/reference/docs-conceptual/AIShell/how-to/aishell-reference.md @@ -159,7 +159,7 @@ The following example copies the all the code to a file. ### `/code post` Post the n-th (1-based) code snippet to the connected command-line shell. Post all the code -when` ` isn't specified. +when `` isn't specified. Usage: diff --git a/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md b/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md index c9a9e65..4ebf2eb 100644 --- a/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md +++ b/reference/docs-conceptual/Crescendo/advanced/transforming-arguments.md @@ -134,5 +134,5 @@ a username and password for the `net use` command. } ``` -The argument transformer converst the **PSCredential** object to `/USER:username password` for the +The argument transformer converts the **PSCredential** object to `/USER:username password` for the `net use` command. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md index f74b094..929466c 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidGlobalFunctions.md @@ -13,7 +13,6 @@ title: AvoidGlobalFunctions Globally scoped functions override existing functions within the sessions with matching names. This name collision can cause difficult to debug issues for consumers of modules. - To understand more about scoping, see `Get-Help about_Scopes`. ## How diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md index 48c914e..9a33149 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/AvoidUsingCmdletAliases.md @@ -20,7 +20,7 @@ There are also implicit aliases. When PowerShell cannot find the cmdlet name, it Every PowerShell author learns the actual command names, but different authors learn and use different aliases. Aliases can make code difficult to read, understand and impact availability. -Using the full command name makes it eaiser to maintain your scripts in the the future. +Using the full command name makes it easier to maintain your scripts in the the future. Using the full command names also allows for syntax highlighting in sites and applications like GitHub and Visual Studio Code. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md index faa6d4c..a523ec4 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PlaceOpenBrace.md @@ -45,5 +45,5 @@ Enforce a new line character after an open brace. The default value is true. #### IgnoreOneLineBlock: bool (Default value is `$true`) Indicates if open braces in a one line block should be ignored or not. For example, -` $x = if ($true) { 'blah' } else { 'blah blah' }`, if the property is set to true then the rule +`$x = if ($true) { 'blah' } else { 'blah blah' }`, if the property is set to true then the rule doesn't fire a violation. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md index bbaf437..11c5d23 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/PossibleIncorrectUsageOfAssignmentOperator.md @@ -52,7 +52,7 @@ if ($a = Get-Something) # Only execute action if command returns something and a } ``` -## Implicit suppresion using Clang style +## Implicit suppression using Clang style There are some rare cases where assignment of variable inside an `if` statement is by design. Instead of suppressing the rule, one can also signal that assignment was intentional by wrapping the diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md index d7570ea..b010295 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/ProvideCommentHelp.md @@ -36,7 +36,7 @@ Rules = @{ ### Parameters -- `Enable`: **bool** (Default valus is `$true`) +- `Enable`: **bool** (Default value is `$true`) Enable or disable the rule during ScriptAnalyzer invocation. diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md index 9d77872..c1bcaa0 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseApprovedVerbs.md @@ -44,4 +44,4 @@ function Update-Item ``` -[01]: /powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands \ No newline at end of file +[01]: /powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands diff --git a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md index 04ca2bf..904ad07 100644 --- a/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md +++ b/reference/docs-conceptual/PSScriptAnalyzer/Rules/UseSupportsShouldProcess.md @@ -18,7 +18,7 @@ authors to provide the desired interactive experience while using the cmdlet. ## Example -### Wrong: +### Wrong ```powershell function foo { @@ -30,7 +30,7 @@ function foo { } ``` -### Correct: +### Correct ```powershell function foo { diff --git a/reference/docs-conceptual/PlatyPS/overview.md b/reference/docs-conceptual/PlatyPS/overview.md index f82c92a..f4c8618 100644 --- a/reference/docs-conceptual/PlatyPS/overview.md +++ b/reference/docs-conceptual/PlatyPS/overview.md @@ -34,4 +34,4 @@ There are two major versions of PlatyPS. [04]: https://github.com/xoofx/markdig [05]: https://wikipedia.org/wiki/Markdown [06]: https://wikipedia.org/wiki/Microsoft_Assistance_Markup_Language -[07]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.PlatyPS \ No newline at end of file +[07]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.PlatyPS diff --git a/reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoCommand.md b/reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoCommand.md index a68375b..d4e8a39 100644 --- a/reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoCommand.md +++ b/reference/ps-modules/Microsoft.PowerShell.Crescendo/Export-CrescendoCommand.md @@ -20,6 +20,7 @@ Export-CrescendoCommand [-command] [-targetDirectory ] [-Wha ``` ### SingleFile + ``` Export-CrescendoCommand [-command] -fileName [-Force] [-WhatIf] [-Confirm] [] diff --git a/reference/ps-modules/Microsoft.PowerShell.Crescendo/Microsoft.PowerShell.Crescendo.md b/reference/ps-modules/Microsoft.PowerShell.Crescendo/Microsoft.PowerShell.Crescendo.md index d22cd21..90860c3 100644 --- a/reference/ps-modules/Microsoft.PowerShell.Crescendo/Microsoft.PowerShell.Crescendo.md +++ b/reference/ps-modules/Microsoft.PowerShell.Crescendo/Microsoft.PowerShell.Crescendo.md @@ -20,31 +20,41 @@ PowerShell cmdlets that are easier to use in automation and packaged to share wi ## Microsoft.PowerShell.Crescendo Cmdlets ### [Export-CrescendoCommand](Export-CrescendoCommand.md) + Creates JSON configuration files for Crescendo **Command** objects. ### [Export-CrescendoModule](Export-CrescendoModule.md) + Creates a module from PowerShell Crescendo JSON configuration files ### [Export-Schema](Export-Schema.md) + Exports the JSON schema for command configuration as a PowerShell object. ### [Import-CommandConfiguration](Import-CommandConfiguration.md) + Import a PowerShell Crescendo json file. ### [New-CrescendoCommand](New-CrescendoCommand.md) + Creates a PowerShell command object. ### [New-ExampleInfo](New-ExampleInfo.md) + Creates a PowerShell object representing an example used in a Crescendo command object. ### [New-OutputHandler](New-OutputHandler.md) + Creates a PowerShell object representing a Crescendo output handler. ### [New-ParameterInfo](New-ParameterInfo.md) + Creates a PowerShell object representing a Crescendo Parameter definition. ### [New-UsageInfo](New-UsageInfo.md) + Creates a PowerShell object representing a Crescendo Usage definition. ### [Test-IsCrescendoCommand](Test-IsCrescendoCommand.md) + Tests whether a cmdlet was created by Crescendo. diff --git a/reference/ps-modules/Microsoft.PowerShell.Crescendo/New-OutputHandler.md b/reference/ps-modules/Microsoft.PowerShell.Crescendo/New-OutputHandler.md index 84371a9..6081e48 100644 --- a/reference/ps-modules/Microsoft.PowerShell.Crescendo/New-OutputHandler.md +++ b/reference/ps-modules/Microsoft.PowerShell.Crescendo/New-OutputHandler.md @@ -20,7 +20,7 @@ New-OutputHandler ## DESCRIPTION Creates a PowerShell object representing a Crescendo output handler. You can assign values to the -properties of the object. The resulting object can be added to the **OutputHanders** property of a +properties of the object. The resulting object can be added to the **OutputHandlers** property of a command object or it can be converted to JSON to be inserted in the configuration file. ## EXAMPLES diff --git a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md index 5d69677..3de36aa 100644 --- a/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md +++ b/reference/ps-modules/Microsoft.PowerShell.PlatyPS/Microsoft.PowerShell.PlatyPS.md @@ -102,4 +102,3 @@ Updates an imported Markdown command file with the information from session cmdl ### [Update-MarkdownModuleFile](Update-MarkdownModuleFile.md) Updates the Markdown module file. - diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md index cc67bb3..3e9f0f3 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretManagement/Microsoft.PowerShell.SecretManagement.md @@ -20,34 +20,45 @@ vaults are registered to the current logged in user context, and are available o ## Microsoft.PowerShell.SecretManagement Cmdlets ### [Get-Secret](Get-Secret.md) + Finds and returns a secret by name from registered vaults. ### [Get-SecretInfo](Get-SecretInfo.md) + Finds and returns metadata information about secrets in registered vaults. ### [Get-SecretVault](Get-SecretVault.md) + Finds and returns registered vault information. ### [Register-SecretVault](Register-SecretVault.md) + Registers a SecretManagement extension vault module for the current user. ### [Remove-Secret](Remove-Secret.md) + Removes a secret from a specified registered extension vault. ### [Set-Secret](Set-Secret.md) + Adds a secret to a SecretManagement registered vault. ### [Set-SecretInfo](Set-SecretInfo.md) + Adds or replaces additional secret metadata to a secret currently stored in a vault. ### [Set-SecretVaultDefault](Set-SecretVaultDefault.md) + Sets the provided vault name as the default vault for the current user. ### [Test-SecretVault](Test-SecretVault.md) + Runs an extension vault self test. ### [Unlock-SecretVault](Unlock-SecretVault.md) + Unlocks an extension vault so that it can be access in the current session. ### [Unregister-SecretVault](Unregister-SecretVault.md) + Un-registers an extension vault from SecretManagement for the current user. diff --git a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md index 723699a..22aed43 100644 --- a/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md +++ b/reference/ps-modules/Microsoft.PowerShell.SecretStore/Microsoft.PowerShell.SecretStore.md @@ -10,6 +10,7 @@ Locale: en-US # Microsoft.PowerShell.SecretStore Module ## Description + Local secure store extension vault for Microsoft.PowerShell.SecretManagement module. > [!NOTE] @@ -24,16 +25,21 @@ Local secure store extension vault for Microsoft.PowerShell.SecretManagement mod ## Microsoft.PowerShell.SecretStore Cmdlets ### [Get-SecretStoreConfiguration](Get-SecretStoreConfiguration.md) + Returns SecretStore configuration information. ### [Reset-SecretStore](Reset-SecretStore.md) + Resets the SecretStore by deleting all secret data and configuring the store with default options. ### [Set-SecretStoreConfiguration](Set-SecretStoreConfiguration.md) + Configures the **SecretStore**. ### [Set-SecretStorePassword](Set-SecretStorePassword.md) + Replaces the current SecretStore password with a new one. ### [Unlock-SecretStore](Unlock-SecretStore.md) + Unlocks SecretStore with the provided password. diff --git a/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md b/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md index df19023..36ad283 100644 --- a/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md +++ b/reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md @@ -21,10 +21,13 @@ checks the quality of PowerShell code by running a set of rules. ## PSScriptAnalyzer Cmdlets ### [Get-ScriptAnalyzerRule](Get-ScriptAnalyzerRule.md) + Gets the script analyzer rules on the local computer. ### [Invoke-Formatter](Invoke-Formatter.md) + Formats a script text based on the input settings or default settings. ### [Invoke-ScriptAnalyzer](Invoke-ScriptAnalyzer.md) + Evaluates a script or module based on selected best practice rules diff --git a/reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md b/reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md index 06a3c00..1f48313 100644 --- a/reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md +++ b/reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md @@ -68,6 +68,7 @@ The first command gets the contents of a file, and stores them in the `$Markdown The second command retrieves metadata from the string in $Metadata. ### Example 3: Get metadata from all files in a folder + ``` PS C:\> Get-MarkdownMetadata -Path ".\docs" diff --git a/reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md b/reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md index 5c953b8..7176d94 100644 --- a/reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md +++ b/reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md @@ -21,7 +21,7 @@ New-MarkdownAboutHelp [-OutputFolder] [[-AboutName] ] [ [-Session ] [-Force] [-Alphabeti ``` ### FromMaml + ``` New-MarkdownHelp -MamlFile [-ConvertNotesToList] [-ConvertDoubleDashLists] [-Force] [-AlphabeticParamsOrder] [-Metadata ] -OutputFolder [-NoMetadata] [-UseFullTypeName] diff --git a/reference/ps-modules/PlatyPS/platyPS.md b/reference/ps-modules/PlatyPS/platyPS.md index 603f14e..c5e9e9a 100644 --- a/reference/ps-modules/PlatyPS/platyPS.md +++ b/reference/ps-modules/PlatyPS/platyPS.md @@ -20,32 +20,41 @@ The platyPS module allows you to create PowerShell External Help in Markdown. ## platyPS Cmdlets ### [Get-HelpPreview](Get-HelpPreview.md) + Displays your generated external help as **Get-Help** output. ### [Get-MarkdownMetadata](Get-MarkdownMetadata.md) + Gets metadata from the header of a markdown file. ### [Merge-MarkdownHelp](Merge-MarkdownHelp.md) + Merge multiple markdown versions of the same cmdlet into a single markdown file. ### [New-ExternalHelp](New-ExternalHelp.md) + Creates external help file based on markdown supported by PlatyPS. ### [New-ExternalHelpCab](New-ExternalHelpCab.md) + Generates a .cab file. ### [New-MarkdownAboutHelp](New-MarkdownAboutHelp.md) + Generates a new About Topic MD file from template. ### [New-MarkdownHelp](New-MarkdownHelp.md) + Creates help in markdown format. ### [New-YamlHelp](New-YamlHelp.md) + Converts Markdown help into YAML to be read easily by external tools ### [Update-MarkdownHelp](Update-MarkdownHelp.md) + Update PlatyPS markdown help files. ### [Update-MarkdownHelpModule](Update-MarkdownHelpModule.md) -Update all files in a markdown help module folder. +Update all files in a markdown help module folder.