Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: initial setup #11

Merged
merged 1 commit into from
Apr 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
![continuous integration](https://github.com/JobaDiniz/ibm-rpa-cli/actions/workflows/build.yml/badge.svg)
![build](https://github.com/Joba-Diniz/ibm-rpa-cli/actions/workflows/build.yml/badge.svg)
![license](https://img.shields.io/github/license/Joba-Diniz/ibm-rpa-cli)
Empty file added docs/.nojekyll
Empty file.
52 changes: 52 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
!> **Warning**: this tool is **unofficial** and it's highly opinionated!

# Get Started
## Install
TODO
## Usage
Create a working directory, for example *Demo*: `mkdir MyProject`.

Open the command line and navigate to the working directory.

Create the RPA project.
```powershell
rpa project new MyProject
```

Create the bot from a template.
```powershell
rpa bot new MyBot --template unattended
```

Add other WAL files to the working directory or pull existing files from an environment.
```powershell
rpa env new dev
rpa pull Demo* --type wal
```

Build the project.
```powershell
rpa build --output "./out"
```

Test the generated WAL file from `out` directory in IBM RPA Studio.

Deploy the project to an environment.
```powershell
rpa env new prod
rpa deploy prod
```


# About
TODO

# Support
TODO

# Author
<img src='https://avatars.githubusercontent.com/u/165290?v=4' alt='Joba' width='75px'/>
<a style='margin-left:10px' href='https://github.com/JobaDiniz' target='_blank'>Joba</a>

# License
Licensed under [MIT](https://getpino.io/#/./LICENSE).
7 changes: 7 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
![logo](_media/icon.svg)

# RPA Command Line Interface

> Unofficial command line interface to manage and deploy IBM RPA projects

[Get Started](#get-started)
26 changes: 26 additions & 0 deletions docs/_media/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* [Home](/)
* [Concepts](concepts.md "RPA concepts")
* [Reference](reference.md "RPA command line reference")
1 change: 1 addition & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TODO
97 changes: 97 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Command Line for IBM RPA</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
<!--<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css" title="docsify-darklight-theme" type="text/css"/>-->
</head>
<body>
<div id="app">Please wait...</div>
<script>
window.$docsify = {
name: 'RPA Cli',
repo: '',
coverpage: true,
loadSidebar: true,
search: 'auto',
darklightTheme: {
light: {
accent: '#E57A44',
},
dark: {
accent: '#E57A44',
}
}
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
<!--<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-powershell.min.js"></script>-->
<script lang="javascript">
(function (Prism) {

var powershell = Prism.languages.powershell = {
'comment': [
{
pattern: /(^|[^`])<#[\s\S]*?#>/,
lookbehind: true
},
{
pattern: /(^|[^`])#.*/,
lookbehind: true
}
],
'string': [
{
pattern: /"(?:`[\s\S]|[^`"])*"/,
greedy: true,
inside: null // see below
},
{
pattern: /'(?:[^']|'')*'/,
greedy: true
}
],
// Matches name spaces as well as casts, attribute decorators. Force starting with letter to avoid matching array indices
// Supports two levels of nested brackets (e.g. `[OutputType([System.Collections.Generic.List[int]])]`)
'namespace': /\[[a-z](?:\[(?:\[[^\]]*\]|[^\[\]])*\]|[^\[\]])*\]/i,
'boolean': /\$(?:false|true)\b/i,
'variable': /\$\w+\b/,
// Cmdlets and aliases. Aliases should come last, otherwise "write" gets preferred over "write-host" for example
// Get-Command | ?{ $_.ModuleName -match "Microsoft.PowerShell.(Util|Core|Management)" }
// Get-Alias | ?{ $_.ReferencedCommand.Module.Name -match "Microsoft.PowerShell.(Util|Core|Management)" }
'function': [
/\b(?:Add|Approve|Assert|Backup|Block|Checkpoint|Clear|Close|Compare|Complete|Compress|Confirm|Connect|Convert|ConvertFrom|ConvertTo|Copy|Debug|Deny|Disable|Disconnect|Dismount|Edit|Enable|Enter|Exit|Expand|Export|Find|ForEach|Format|Get|Grant|Group|Hide|Import|Initialize|Install|Invoke|Join|Limit|Lock|Measure|Merge|Move|New|Open|Optimize|Out|Ping|Pop|Protect|Publish|Push|Read|Receive|Redo|Register|Remove|Rename|Repair|Request|Reset|Resize|Resolve|Restart|Restore|Resume|Revoke|Save|Search|Select|Send|Set|Show|Skip|Sort|Split|Start|Step|Stop|Submit|Suspend|Switch|Sync|Tee|Test|Trace|Unblock|Undo|Uninstall|Unlock|Unprotect|Unpublish|Unregister|Update|Use|Wait|Watch|Where|Write)-[a-z]+\b/i,
/\b(?:ac|cat|chdir|clc|cli|clp|clv|compare|copy|cp|cpi|cpp|cvpa|dbp|del|diff|dir|ebp|echo|epal|epcsv|epsn|erase|fc|fl|ft|fw|gal|gbp|gc|gci|gcs|gdr|gi|gl|gm|gp|gps|group|gsv|gu|gv|gwmi|iex|ii|ipal|ipcsv|ipsn|irm|iwmi|iwr|kill|lp|ls|measure|mi|mount|move|mp|mv|nal|ndr|ni|nv|ogv|popd|ps|pushd|pwd|rbp|rd|rdr|ren|ri|rm|rmdir|rni|rnp|rp|rv|rvpa|rwmi|sal|saps|sasv|sbp|sc|select|set|shcm|si|sl|sleep|sls|sort|sp|spps|spsv|start|sv|swmi|tee|trcm|type|write)\b/i
],
// per http://technet.microsoft.com/en-us/library/hh847744.aspx
'keyword': /\b(?:rpa|Begin|Break|Catch|Class|Continue|Data|Define|Do|DynamicParam|Else|ElseIf|End|Exit|Filter|Finally|For|ForEach|From|Function|If|InlineScript|Parallel|Param|Process|Return|Sequence|Switch|Throw|Trap|Try|Until|Using|Var|While|Workflow)\b/i,
'operator': {
pattern: /(^|\W)(?:!|-(?:b?(?:and|x?or)|as|(?:Not)?(?:Contains|In|Like|Match)|eq|ge|gt|is(?:Not)?|Join|le|lt|ne|not|Replace|sh[lr])\b|-[-=]?|\+[+=]?|[*\/%]=?)/i,
lookbehind: true
},
'punctuation': /[|{}[\];(),.]/
};

// Variable interpolation inside strings, and nested expressions
powershell.string[0].inside = {
'function': {
// Allow for one level of nesting
pattern: /(^|[^`])\$\((?:\$\([^\r\n()]*\)|(?!\$\()[^\r\n)])*\)/,
lookbehind: true,
inside: powershell
},
'boolean': powershell.boolean,
'variable': powershell.variable,
};

}(Prism));
</script>
<!--<script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js" type="text/javascript"></script>-->
</body>
</html>
1 change: 1 addition & 0 deletions docs/reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# TODO