robotcode¶
Usage:
robotcode [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-c, --config |
path | Config file to use. Can be specified multiple times. | |
| If not specified, the default config file is used. | None | ||
-p, --profile |
text | The Execution Profile to use. Can be specified multiple times. | |
| If not specified, the default profile is used. | None | ||
-f, --format |
choice (toml | json | json-indent | text) |
Set the output format. | None |
-d, --dry |
boolean | Dry run, do not execute any commands. | False |
--color / --no-color |
boolean | Whether or not to display colored output (default is auto-detection). | None |
--pager / --no-pager |
boolean | Whether or not use a pager to display long text or data. | False |
-v, --verbose |
boolean | Enables verbose mode. | False |
--log |
boolean | Enables logging. | False |
--log-level |
choice (TRACE | DEBUG | INFO | WARNING | ERROR | CRITICAL) |
Sets the log level. | CRITICAL |
--log-filename |
file | Write log output to a file instead to console. | None |
--log-calls |
boolean | Enables logging of method/function calls. | False |
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- analyze: TODO: Analyzes a Robot Framework project.
- clean: TODO: Cleans a Robot Framework project.
- config: Shows information about the configuration.
- debug: Starts a Robot Framework debug session and waits for incomming connections.
- discover: Commands to discover informations about the current project.
- language-server: Run Robot Framework Language Server.
- libdoc: Runs
libdocwith the selected configuration, profiles, options and arguments. - new: TODO: Create a new Robot Framework project.
- profiles: Shows information on defined profiles.
- rebot: Runs
rebotwith the selected configuration, profiles, options and arguments. - robot: Runs
robotwith the selected configuration, profiles, options and arguments. - testdoc: Runs
testdocwith the selected configuration, profiles, options and arguments.
robotcode analyze¶
TODO: Analyzes a Robot Framework project.
Usage:
robotcode analyze [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
robotcode clean¶
TODO: Cleans a Robot Framework project.
TODO: This is not implemented yet.
Usage:
robotcode clean [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode config¶
Shows information about the configuration.
Usage:
robotcode config [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- files: Search for configuration files and list them.
- info: Shows informations about possible configuration settings.
- root: Searches for the root folder of the project and prints them.
- show: Shows the current configuration.
robotcode config files¶
Search for configuration files and list them.
Takes a list of PATHS or if no PATHS are given, takes the current working directory, to search for configuration files and prints them.
Examples:
robotcode config files
robotcode config files tests/acceptance/first.robot
Usage:
robotcode config files [OPTIONS] [PATHS]... [USER]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode config info¶
Shows informations about possible configuration settings.
Usage:
robotcode config info [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- desc: Shows the description of the specified configuration settings.
- list: Lists all possible configuration settings.
robotcode config info desc¶
Shows the description of the specified configuration settings.
If no NAME is given shows the description of all possible configuration settings. Wildcards are supported.
Examples:
robotcode config info desc
robotcode config info desc python-path
robotcode config info desc rebot.*
robotcode config info desc *tag*
Usage:
robotcode config info desc [OPTIONS] [NAME]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode config info list¶
Lists all possible configuration settings.
If NAME is given searches for given name. Wildcards are supported.
Examples:
robotcode config info list
robotcode config info list rebot.*
robotcode config info list *tag*
Usage:
robotcode config info list [OPTIONS] [NAME]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode config root¶
Searches for the root folder of the project and prints them.
Takes a list of PATHS or if no PATHS are given, takes the current working directory, to search for the root of the project and prints this.
Examples:
robotcode config root
robotcode config root tests/acceptance/first.robot
Usage:
robotcode config root [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode config show¶
Shows the current configuration.
Takes a list of PATHS or if no PATHS are given, takes the current working directory, to search for configuration files and prints the current configuration.
Examples:
robotcode config show
robotcode config show tests/acceptance/first.robot
robotcode --format json config show
Usage:
robotcode config show [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-s, --single |
boolean | Shows single files, not the combined config. | False |
--help |
boolean | Show this message and exit. | False |
robotcode debug¶
Starts a Robot Framework debug session and waits for incomming connections.
Usage:
robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--debug / --no-debug |
boolean | Enable/disable debug mode | True |
--stop-on-entry / --no-stop-on-entry |
boolean | Breaks into debugger when a robot framework run starts. | False |
--wait-for-client / --no-wait-for-client |
boolean | Waits until a debug client is connected. | True |
--wait-for-client-timeout |
float | Timeout in seconds for waiting for a connection with a debug client. | 10 |
--configuration-done-timeout |
float | Timeout to wait for a configuration from client. | 10 |
--debugpy / --no-debugpy |
boolean | Enable/disable python debugging. | False |
--debugpy-wait-for-client |
boolean | Waits for a debugpy client to connect. | True |
--debugpy-port |
integer | The port for the debugpy session. | 5678 |
--output-messages / --no-output-messages |
boolean | Send output messages from robot framework to client. | False |
--output-log / --no-output-log |
boolean | Send log messages from robotframework to client. | True |
--output-timestamps / --no-output-timestamps |
boolean | Include timestamps in log and output messages. | False |
--group-output / --no-group-output |
boolean | Fold/group messages or log messages. | False |
--tcp |
[:] |
Run in tcp server mode and listen at the given port. (Equivalent to --mode tcp --port <port>) |
|
| NOTE: This option is mutually exclusive with options: pipe-name, pipe-server, port, mode. | None | ||
--pipe-server |
name | Run in pipe-server mode and listen at the given pipe name. (Equivalent to --mode pipe-server --pipe-name <name>) |
|
| NOTE: This option is mutually exclusive with options: mode, port, tcp, pipe-name, bind. | None | ||
--mode |
choice (tcp | pipe-server) |
The mode to use for the debug launch server. | |
| NOTE: This option is mutually exclusive with options: tcp, pipe-server. | tcp |
||
--port |
port (between 1 and 65535) |
The port to listen on or connect to. (Only valid for tcp and socket mode) |
|
| NOTE: This option is mutually exclusive with options: pipe-server, pipe-name. | 6612 |
||
--bind |
address | Specify alternate bind address. If no address is specified localhost is used. (Only valid for tcp and socket mode) |
|
| NOTE: This option is mutually exclusive with options: pipe-server, pipe-name. | ['127.0.0.1'] |
||
--pipe-name |
name | The pipe to listen on or connect to. (Only valid in pipe and pipe-server mode) |
|
| NOTE: This option is mutually exclusive with options: tcp, bind, port, pipe-server. | None | ||
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
robotcode discover¶
Commands to discover informations about the current project.
Examples:
robotcode discover tests
robotcode --profile regression discover tests
Usage:
robotcode discover [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--diagnostics / --no-diagnostics |
boolean | Display robot parsing errors and warning that occur during discovering. |
True |
--help |
boolean | Show this message and exit. | False |
Subcommands
- all: Discover suites, tests, tasks with the selected configuration,
- info: Shows some informations about the current robot environment.
- suites: Discover suites with the selected configuration, profiles, options and
- tags: Discover tags with the selected configuration, profiles, options and
- tests: Discover tests with the selected configuration, profiles, options and
robotcode discover all¶
Discover suites, tests, tasks with the selected configuration, profiles, options and arguments.
You can use all known robot arguments to filter for example by tags or to use pre-run-modifier.
Examples:
robotcode discover all
robotcode --profile regression discover all
robotcode --profile regression discover all --include regression --exclude wipANDnotready
Usage:
robotcode discover all [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--by-longname |
text | Select tests/tasks or suites by longname. | None |
--exclude-by-longname |
text | Excludes tests/tasks or suites by longname. | None |
--help |
boolean | Show this message and exit. | False |
robotcode discover info¶
Shows some informations about the current robot environment.
Examples:
robotcode discover info
Usage:
robotcode discover info [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode discover suites¶
Discover suites with the selected configuration, profiles, options and arguments.
You can use all known robot arguments to filter for example by tags or to use pre-run-modifier.
Examples:
robotcode discover suites
robotcode --profile regression discover suites
robotcode --profile regression discover suites --include regression --exclude wipANDnotready
Usage:
robotcode discover suites [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--by-longname |
text | Select tests/tasks or suites by longname. | None |
--exclude-by-longname |
text | Excludes tests/tasks or suites by longname. | None |
--help |
boolean | Show this message and exit. | False |
robotcode discover tags¶
Discover tags with the selected configuration, profiles, options and arguments.
You can use all known robot arguments to filter for example by tags or to use pre-run-modifier.
Examples:
robotcode discover tags
robotcode --profile regression discover tags
robotcode --profile regression discover tags --tests -i wip
Usage:
robotcode discover tags [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--normalized / --not-normalized |
boolean | Whether or not normalized tags are shown. | True |
--tests / --no-tests |
boolean | Show tests where the tag is present. | False |
--full-paths / --no-full-paths |
boolean | Show full paths instead of releative. | False |
--version |
boolean | Show the version and exit. | False |
--by-longname |
text | Select tests/tasks or suites by longname. | None |
--exclude-by-longname |
text | Excludes tests/tasks or suites by longname. | None |
--help |
boolean | Show this message and exit. | False |
robotcode discover tests¶
Discover tests with the selected configuration, profiles, options and arguments.
You can use all known robot arguments to filter for example by tags or to use pre-run-modifier.
Examples:
robotcode discover tests
robotcode --profile regression discover tests
robotcode --profile regression discover tests --include regression --exclude wipANDnotready
Usage:
robotcode discover tests [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--tags / --no-tags |
boolean | Show the tags that are present. | False |
--full-paths / --no-full-paths |
boolean | Show full paths instead of releative. | False |
--version |
boolean | Show the version and exit. | False |
--by-longname |
text | Select tests/tasks or suites by longname. | None |
--exclude-by-longname |
text | Excludes tests/tasks or suites by longname. | None |
--help |
boolean | Show this message and exit. | False |
robotcode language-server¶
Run Robot Framework Language Server.
Usage:
robotcode language-server [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--stdio |
boolean | Run in stdio mode. (Equivalent to --mode stdio) |
|
| NOTE: This option is mutually exclusive with options: mode, socket, port, pipe, tcp, pipe-name, bind. | False |
||
--tcp |
[:] |
Run in tcp server mode and listen at the given port. (Equivalent to --mode tcp --port <port>) |
|
| NOTE: This option is mutually exclusive with options: mode, socket, port, pipe, stdio, pipe-name. | None | ||
--socket |
[:] |
Run in socket mode and connect to the given port. (Equivalent to --mode socket --port <port>) |
|
| NOTE: This option is mutually exclusive with options: mode, port, pipe, stdio, tcp, pipe-name. | None | ||
--pipe |
name | Run in pipe mode and connect to the given pipe name. (Equivalent to --mode pipe --pipe-name <name>) |
|
| NOTE: This option is mutually exclusive with options: mode, socket, port, stdio, tcp, pipe-name, bind. | None | ||
--mode |
choice (stdio | socket | tcp | pipe) |
The mode to use for the debug launch server. | |
| NOTE: This option is mutually exclusive with options: stdio, socket, tcp, pipe. | stdio |
||
--port |
port (between 1 and 65535) |
The port to listen on or connect to. (Only valid for tcp and socket mode) |
|
| NOTE: This option is mutually exclusive with options: pipe, pipe-name. | 6610 |
||
--bind |
address | Specify alternate bind address. If no address is specified localhost is used. (Only valid for tcp and socket mode) |
|
| NOTE: This option is mutually exclusive with options: pipe, pipe-name. | ['127.0.0.1'] |
||
--pipe-name |
name | The pipe to listen on or connect to. (Only valid in pipe and pipe-server mode) |
|
| NOTE: This option is mutually exclusive with options: socket, port, pipe, stdio, tcp, bind. | None | ||
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
robotcode libdoc¶
Runs libdoc with the selected configuration, profiles, options and arguments.
The options and arguments are passed to libdoc as is.
Usage:
robotcode libdoc [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
robotcode new¶
TODO: Create a new Robot Framework project.
TODO: This is not implemented yet.
Usage:
robotcode new [OPTIONS]
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
robotcode profiles¶
Shows information on defined profiles.
Usage:
robotcode profiles [OPTIONS] COMMAND [ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--help |
boolean | Show this message and exit. | False |
Subcommands
- list: Lists the defined profiles in the current configuration.
- show: Shows the given profile configuration.
robotcode profiles list¶
Lists the defined profiles in the current configuration.
Usage:
robotcode profiles list [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-h, --show-hidden |
boolean | Show hidden profiles. | False |
-sp, --sort-by-precedence |
boolean | Sort by precedence. | False |
--help |
boolean | Show this message and exit. | False |
robotcode profiles show¶
Shows the given profile configuration.
Usage:
robotcode profiles show [OPTIONS] [PATHS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
-n, --no-evaluate |
boolean | Don't evaluate expressions in the profile. | False |
--help |
boolean | Show this message and exit. | False |
robotcode rebot¶
Runs rebot with the selected configuration, profiles, options and arguments.
The options and arguments are passed to rebot as is.
Usage:
robotcode rebot [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
robotcode robot¶
Runs robot with the selected configuration, profiles, options and arguments.
The options and arguments are passed to robot as is.
Examples:
robotcode robot
robotcode robot tests
robotcode robot -i regression -e wip tests
robotcode --profile ci robot -i regression -e wip tests
Usage:
robotcode robot [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--by-longname |
text | Select tests/tasks or suites by longname. | None |
--exclude-by-longname |
text | Excludes tests/tasks or suites by longname. | None |
--help |
boolean | Show this message and exit. | False |
robotcode testdoc¶
Runs testdoc with the selected configuration, profiles, options and arguments.
The options and arguments are passed to testdoc as is.
Usage:
robotcode testdoc [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |