Robomotion
Search…
robomotion-deskbot
Learn how to use a robot from the command line interface
You can connect a robot to your workspace from the command line interface.
1
Usage:
2
robomotion-deskbot [command]
3
4
Available Commands:
5
connect Connects to your workspace
6
help Help about any command
7
8
Flags:
9
--config string config file (default is $HOME/.newApp.yaml)
10
-h, --help help for robomotion-deskbot
11
--stdin get input from stdin
12
-v, --version version for robomotion-deskbot
13
14
Use "robomotion-deskbot [command] --help" for more information about a command.
15
Copied!

Connect

In order to connect a robot to your workspace, you can use the connect command
1
Usage:
2
robomotion-deskbot connect [flags]
3
4
Flags:
5
-h, --help help for connect
6
-i, --identity string Robomotion identity
7
--log-level string Robomotion log level ('info', 'warning', 'error', 'off')
8
--logdir string Robomotion log directory
9
-n, --no-attach Do not attach to Flow Designer
10
--remember Remembers last used Robomotion credentials
11
-r, --robot string Robomotion robot name or id
12
-t, --token string Robomotion robot token
13
-w, --workspace string Robomotion workspace
14
15
Global Flags:
16
--config string config file (default is $HOME/.newApp.yaml)
17
--stdin get input from stdin
18
19
Copied!
Parameter
Shortcut
Description
--identity
-i
Email address used to connect to your workspace
--workspace
-w
Workspace address
--no-attach
-n
No attach to Flow Designer
--remember
Remember provided credentials
--robot
-r
Robot name or Robot ID
--token
-t
Robot access token

Example usages

User Authentication

1
robomotion-deskbot connect -i [email protected] -w rpa.acme.inc
Copied!
If credentials are correct, the available robots in your workspace will be listed.
1
Use the arrow keys to navigate: ↓ ↑ → ←
2
? Select Your Robot:
3
▸ Butler [ID: 624609c6-1a27-458f-ace5-3889dc554e28]
4
Jarvas [ID: 20f1cdb9-d8d9-448b-984c-9188deb24e8e]
Copied!
After your selection, the selected robot will start working on your computer.
1
{"level":"info","msg":"Connecting to rpa.acme.inc","status":"connecting","time":"2021-10-21T13:24:46+03:00"}
2
{"level":"info","msg":"Connected to rpa.acme.inc as Butler [v1.16.0]","status":"connected","time":"2021-10-21T13:24:46+03:00"}
Copied!

User Authentication with Remember

1
robomotion-deskbot connect -i [email protected] -w rpa.acme.inc --remember
Copied!
If credentials are correct, the available robots in your workspace will be listed.
1
Use the arrow keys to navigate: ↓ ↑ → ←
2
? Select Your Robot:
3
▸ Butler [ID: 624609c6-1a27-458f-ace5-3889dc554e28]
4
Jarvas [ID: 20f1cdb9-d8d9-448b-984c-9188deb24e8e]
Copied!
After your selection, the selected robot will start working and the provided credentials will be stored on your computer.
1
{"level":"info","msg":"Connecting to rpa.acme.inc","status":"connecting","time":"2021-10-21T13:24:46+03:00"}
2
{"level":"info","msg":"Connected to rpa.acme.inc as Butler [v1.16.0]","status":"connected","time":"2021-10-21T13:24:46+03:00"}
Copied!
For the next connections, you can use the stored credentials.
1
robomotion-deskbot connect
2
{"level":"info","msg":"Connecting to rpa.acme.inc","status":"connecting","time":"2021-10-21T13:24:46+03:00"}
3
{"level":"info","msg":"Connected to rpa.acme.inc as Butler [v1.16.0]","status":"connected","time":"2021-10-21T13:24:46+03:00"}
Copied!

Robot Authentication

1
robomotion-deskbot connect -r 624609c6-1a27-458f-ace5-3889dc554e28 -t ccb15ec1cbf40ae79fe0a0f317c78a23 -w rpa.acme.inc
Copied!
You can connect a robot without giving user credentials. In order to get detailed information about robot access tokens, please refer to the following section.
Robots
Robomotion
Copy link