Bin/Com.ScriptRunner.UI.ISEAddOn.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-ISEScriptRunner</command:name> <command:verb>Disable</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Remove ScriptRunner ISE Add-on Tool from the ISE profile of the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove the startup code of ScriptRunner ISE Add-on Tool from the ISE profile of the current user. The ScriptRunner ISE Add-on Tool is not loaded at the startup of the Windows PowerShell ISE anymore.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disable-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-ISEScriptRunner</command:name> <command:verb>Enable</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Add ScriptRunner ISE Add-on Tool to the ISE profile of the current user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add ScriptRunner ISE Add-on Tool to the ISE profile of the current user. The ScriptRunner ISE Add-on Tool is automatically loaded at the startup of the Windows PowerShell ISE. The Windows PowerShell ISE is created, if it does not exist.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Enable-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-ISEScriptRunnerConfig</command:name> <command:verb>Get</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Get the configuration settings of the ISEScriptRunner module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get the configuration settings of the ISEScriptRunner module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-ISEScriptRunnerConfig</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Hide-ISEScriptRunner</command:name> <command:verb>Hide</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Hide ScriptRunner ISE Add-on Tool from the current Windows PowerShell ISE console pane.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hide ScriptRunner ISE Add-on Tool from the current Windows PowerShell ISE console pane.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Hide-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-SRXEnv</command:name> <command:verb>Reset</command:verb> <command:noun>SRXEnv</command:noun> <maml:description> <maml:para>Reset global ScriptRunner PowerShell Host Environment Variable $SRXEnv.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Reset global ScriptRunner PowerShell Host Environment Variable $SRXEnv.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Reset-SRXEnv</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-ISEScriptRunnerConfig</command:name> <command:verb>Set</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Set configuration settings of the ISEScriptRunner module.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set configuration settings of the ISEScriptRunner module.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-ISEScriptRunnerConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Set the uri of the ScriptRunner WebAPI service. e.g. 'http://localhost/scriptrunner/'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Set the filepath of the pwsh executable. e.g. 'C:\Program Files\PowerShell\7\pwsh.exe'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Set the uri of the ScriptRunner WebAPI service. e.g. 'http://localhost/scriptrunner/'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Set the filepath of the pwsh executable. e.g. 'C:\Program Files\PowerShell\7\pwsh.exe'</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Set-ISEScriptRunnerConfig -BackendUri 'https://myhost.mydomain.net/scriptrunner/'</dev:code> <dev:remarks> <maml:para>Set the uri of the ScriptRunner WebAPI service to 'https://myhost.mydomain.net/scriptrunner/'.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Set-ISEScriptRunnerConfig -PwshExeFilepath 'C:\Program Files\PowerShell\7-preview\pwsh.exe'</dev:code> <dev:remarks> <maml:para>Set the filepath of the pwsh executable to 'C:\Program Files\PowerShell\7-preview\pwsh.exe'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-ISEScriptRunner</command:name> <command:verb>Start</command:verb> <command:noun>ISEScriptRunner</command:noun> <maml:description> <maml:para>Open ScriptRunner ISE Add-on in the current Windows PowerShell ISE console pane.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Open ScriptRunner ISE Add-on in the current Windows PowerShell ISE console pane.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-ISEScriptRunner</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-ISEScriptRunnerConfig</command:name> <command:verb>Test</command:verb> <command:noun>ISEScriptRunnerConfig</command:noun> <maml:description> <maml:para>Test if the configuration settings of the ISEScriptRunner module are valid.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Test if the configuration settings of the ISEScriptRunner module are valid. Test if the uri of the ScriptRunner WebAPI service is reachable. Test if the filepath to the pwsh executable file exists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-ISEScriptRunnerConfig</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Test if the uri of the ScriptRunner WebAPI service is reachable.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Test if the filepath to the pwsh executable file exists.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackendUri</maml:name> <maml:description> <maml:para>Test if the uri of the ScriptRunner WebAPI service is reachable.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PwshExeFilepath</maml:name> <maml:description> <maml:para>Test if the filepath to the pwsh executable file exists.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipCertificateCheck</maml:name> <maml:description> <maml:para>Skips certificate validation checks. This includes all validations such as expiration, revocation, trusted root authority, etc.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples /> <command:relatedLinks /> </command:command> </helpItems> |