Docs

Author: rusanu

Generate-CmdletDocs.ps1

@@ -0,0 +1,17 @@
+
+$cmdlets = Get-Command -Module UiPath.PowerShell | select Name
+
+$file = "docs\Home.md"
+"" | Out-File $file -Encoding utf8
+foreach($cmdlet in $cmdlets)
+{
+	"[$($cmdlet.Name)]($($cmdlet.Name).md)" | Out-File  $file -Encoding utf8 -Append
+}
+
+foreach($cmdlet in $cmdlets) 
+{
+	$file = "docs\$($cmdlet.Name).md"
+	"``````PowerShell" | Out-File $file -Encoding utf8
+	Get-Help $cmdlet.Name | Out-File $file -Encoding utf8 -Append
+	"``````" | Out-File $file -Encoding utf8 -Append
+}

LICENSE renamed to LICENSE.md

@@ -1,3 +1,52 @@
 # UiPath Orchestrator PowerShell library
 
-A PowerShell library for interacting with UiPath Orchestrator.
+A PowerShell library for interacting with [UiPath Orchestrator](https://orchestrator.uipath.com/).
+
+# Getting Started
+
+Build solution to obtain the `UiPath.PowerShell.dll` module. Import the module in PowerShell:
+
+```PowerShell
+PS C:\>Import-Module UiPath.PowerShell.dll
+```
+
+Use the PowerShell `Get-Command` to obtain all cmdlets exported by the module:
+
+```PowerShell
+PS C:\>Get-Help -Module UiPath.PowerShell
+```
+
+You can obtain each command syntax using PowerShell's own `Get-Help`:
+
+```PowerShell
+PS C:\>Get-Help Add-UiPathRobot
+```
+
+To start using the library, you need to connect first to a running Orchestrator instance. Use the [`Get-UiPathAuthToken`](docs/Get-UiPathAuthToken.md) cmdlet:
+```PowerShell
+PS C:\>Get-UiPathAuthToken -URL <orchestratorurl> -Username <OrchestratorUser> -Password <password> -Session
+```
+
+The `-Session` flag makes the authentication persist on the PowerShell session for up to 30 minutes. After this you will not have to authenticate again each cmdlet. Some examples:
+
+```PowerShell
+S C:\> Get-UiPathRobot | Format-Table
+
+ Id LicenseKey MachineName    Name           Description
+ -- ---------- -----------    ----           -----------
+
+132            RERUSANU       PwdRobot1
+133            RERUSANU       PwdRobot2
+134            RERUSANU       PwdRobot3
+```
+
+For more example, see the [docs](docs/Home.md)
+
+# Prerequisites
+
+To build the project, In addition to the C# SDK (the solution is Visual Studio 2017 based) you will need [autorest](https://github.com/Azure/autorest).
+To use the library you won't need anything but the build artifacts.
+
+# License
+
+This project is copyright [UiPath INC](https://uipath.com) and licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

README.md

@@ -9,6 +9,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UiPath.PowerShell", "UiPath
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{5B414573-14ED-4BCC-AE35-FE9F6173BE86}"
 	ProjectSection(SolutionItems) = preProject
+		LICENSE.md = LICENSE.md
 		README.md = README.md
 	EndProjectSection
 EndProject

UiPath.Orchestrator.Powershell.sln

@@ -0,0 +1,44 @@
+```PowerShell
+
+NAME
+    Add-UiPathAsset
+    
+SYNOPSIS
+    Adds an Asset into Orchestrator
+    
+    
+SYNTAX
+    Add-UiPathAsset [-Name] <string> -TextValue <string> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -IntValue <int> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -DBConnectionString <string> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -HttpConnectionString <string> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -BoolValue <bool> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -KeyValueList <Hashtable> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -WindowsCredential <PSCredential> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -Credential <PSCredential> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    Add-UiPathAsset [-Name] <string> -RobotValues <Hashtable> -ValueType <string> [-AuthToken <AuthToken>] 
+    [<CommonParameters>]
+    
+    
+DESCRIPTION
+    This cmdlet can add global asset value or per-robot asset values.
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathAsset -examples".
+    For more information, type: "get-help Add-UiPathAsset -detailed".
+    For technical information, type: "get-help Add-UiPathAsset -full".
+
+
+
+```

docs/Add-UiPathAsset.md

@@ -0,0 +1,26 @@
+```PowerShell
+
+NAME
+    Add-UiPathEnvironment
+    
+SYNOPSIS
+    
+    
+SYNTAX
+    Add-UiPathEnvironment -Name <string> [-AuthToken <AuthToken>] [-Description <string>] [-Type <string>] 
+    [<CommonParameters>]
+    
+    
+DESCRIPTION
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathEnvironment -examples".
+    For more information, type: "get-help Add-UiPathEnvironment -detailed".
+    For technical information, type: "get-help Add-UiPathEnvironment -full".
+
+
+
+```

docs/Add-UiPathEnvironment.md

@@ -0,0 +1,25 @@
+```PowerShell
+
+NAME
+    Add-UiPathEnvironmentRobot
+    
+SYNOPSIS
+    
+    
+SYNTAX
+    Add-UiPathEnvironmentRobot -Environment <Environment> -Robot <Robot> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    
+DESCRIPTION
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathEnvironmentRobot -examples".
+    For more information, type: "get-help Add-UiPathEnvironmentRobot -detailed".
+    For technical information, type: "get-help Add-UiPathEnvironmentRobot -full".
+
+
+
+```

docs/Add-UiPathEnvironmentRobot.md

@@ -0,0 +1,25 @@
+```PowerShell
+
+NAME
+    Add-UiPathPackage
+    
+SYNOPSIS
+    
+    
+SYNTAX
+    Add-UiPathPackage [-PackageFile] <string> [-AuthToken <AuthToken>] [<CommonParameters>]
+    
+    
+DESCRIPTION
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathPackage -examples".
+    For more information, type: "get-help Add-UiPathPackage -detailed".
+    For technical information, type: "get-help Add-UiPathPackage -full".
+
+
+
+```

docs/Add-UiPathPackage.md

@@ -0,0 +1,26 @@
+```PowerShell
+
+NAME
+    Add-UiPathProcess
+    
+SYNOPSIS
+    
+    
+SYNTAX
+    Add-UiPathProcess -Name <string> [-AuthToken <AuthToken>] [-Description <string>] [-Environment <Environment>] 
+    [-EnvironmentId <long>] [-Package <Package>] [-PackageId <string>] [-PackageVersion <string>] [<CommonParameters>]
+    
+    
+DESCRIPTION
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathProcess -examples".
+    For more information, type: "get-help Add-UiPathProcess -detailed".
+    For technical information, type: "get-help Add-UiPathProcess -full".
+
+
+
+```

docs/Add-UiPathProcess.md

@@ -0,0 +1,26 @@
+```PowerShell
+
+NAME
+    Add-UiPathQueuItem
+    
+SYNOPSIS
+    
+    
+SYNTAX
+    Add-UiPathQueuItem -QueueName <string> [-AuthToken <AuthToken>] [-DeferDate <DateTime>] [-DueDate <DateTime>] 
+    [-Priority <string>] [-Reference <string>] [-SpecificContent <Hashtable>] [<CommonParameters>]
+    
+    
+DESCRIPTION
+    
+
+RELATED LINKS
+
+REMARKS
+    To see the examples, type: "get-help Add-UiPathQueuItem -examples".
+    For more information, type: "get-help Add-UiPathQueuItem -detailed".
+    For technical information, type: "get-help Add-UiPathQueuItem -full".
+
+
+
+```