robotcode¶
Usage:
robotcode [OPTIONS] COMMAND [ARGS]...
Options:
-c, --config PATH Config file to use. Can be specified
multiple times. If not specified, the
default config file is used.
-p, --profile TEXT The Execution Profile to use. Can be
specified multiple times. If not specified,
the default profile is used.
-f, --format [toml|json|json-indent|text]
Set the output format.
-d, --dry Dry run, do not execute any commands.
--color / --no-color Whether or not to display colored output
(default is auto-detection).
--pager / --no-pager Whether or not use a pager to display long
text or data.
-v, --verbose Enables verbose mode.
--log Enables logging.
--log-level [TRACE|DEBUG|INFO|WARNING|ERROR|CRITICAL]
Sets the log level. [default: CRITICAL]
--log-calls Enables logging of method/function calls.
--version Show the version and exit.
--help Show this message and exit.
Subcommands
- analyze: TODO: Analyzes a Robot Framework project.
- clean: TODO: Cleans a Robot Framework project.
- config: View configuration informations.
- 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: View robot profile informations.
- 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:
--version Show the version and exit.
--help Show this message and exit.
robotcode clean¶
TODO: Cleans a Robot Framework project.
TODO: This is not implemented yet.
Usage:
robotcode clean [OPTIONS]
Options:
--help Show this message and exit.
robotcode config¶
View configuration informations.
Usage:
robotcode config [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- files: Search for robot configuration files and list them.
- info: Shows informations about possible configuration settings.
- root: Searches for the root folder of the robot project and prints them.
- show: Shows the current robot configuration.
robotcode config files¶
Search for robot 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:
--help Show this message and exit.
robotcode config info¶
Shows informations about possible configuration settings.
Usage:
robotcode config info [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
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:
--help Show this message and exit.
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:
--help Show this message and exit.
robotcode config root¶
Searches for the root folder of the robot 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:
--help Show this message and exit.
robotcode config show¶
Shows the current robot 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:
-s, --single Shows single files, not the combined config.
--help Show this message and exit.
robotcode debug¶
Starts a Robot Framework debug session and waits for incomming connections.
Usage:
robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
--debug / --no-debug Enable/disable debug mode [default: debug]
--stop-on-entry / --no-stop-on-entry
Breaks into debugger when a robot framework
run starts. [default: no-stop-on-entry]
--wait-for-client / --no-wait-for-client
Waits until a debug client is connected.
[default: wait-for-client]
--wait-for-client-timeout FLOAT
Timeout in seconds for waiting for a
connection with a debug client. [default:
10]
--configuration-done-timeout FLOAT
Timeout to wait for a configuration from
client. [default: 10]
--debugpy / --no-debugpy Enable/disable python debugging. [default:
no-debugpy]
--debugpy-wait-for-client Waits for a debugpy client to connect.
--debugpy-port INTEGER The port for the debugpy session. [default:
5678]
--output-messages / --no-output-messages
Send output messages from robot framework to
client. [default: no-output-messages]
--output-log / --no-output-log Send log messages from robotframework to
client. [default: output-log]
--output-timestamps / --no-output-timestamps
Include timestamps in log and output
messages. [default: no-output-timestamps]
--group-output / --no-group-output
Fold/group messages or log messages.
[default: no-group-output]
--tcp [<ADDRESS>:]<PORT> 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-
server, port, mode, pipe-name.
--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: tcp, mode, port, pipe-name, bind.
--mode [pipe-server|tcp] The mode to use for the debug launch server.
*NOTE:* This option is mutually exclusive
with options: pipe-server, tcp. [default:
tcp]
--port PORT 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. [default:
6612; 1<=x<=65535]
--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. [default:
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: pipe-server, port, bind, tcp.
--version Show the version and exit.
--help Show this message and exit.
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:
--help Show this message and exit.
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:
--diagnostics / --no-diagnostics
Display `robot` parsing errors and warning
that occur during discovering. [default:
diagnostics]
--by-longname TEXT Select tests/tasks or suites by longname.
--exclude-by-longname TEXT Excludes tests/tasks or suites by longname.
--version Show the version and exit.
--help Show this message and exit.
robotcode discover info¶
Shows some informations about the current robot environment.
Examples:
robotcode discover info
Usage:
robotcode discover info [OPTIONS]
Options:
--help Show this message and exit.
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:
--diagnostics / --no-diagnostics
Display `robot` parsing errors and warning
that occur during discovering. [default:
diagnostics]
--by-longname TEXT Select tests/tasks or suites by longname.
--exclude-by-longname TEXT Excludes tests/tasks or suites by longname.
--version Show the version and exit.
--help Show this message and exit.
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:
--normalized / --not-normalized
Whether or not normalized tags are shown.
[default: normalized]
--tests / --no-tests Show tests where the tag is present.
[default: no-tests]
--full-paths / --no-full-paths Show full paths instead of releative.
[default: no-full-paths]
--diagnostics / --no-diagnostics
Display `robot` parsing errors and warning
that occur during discovering. [default:
diagnostics]
--by-longname TEXT Select tests/tasks or suites by longname.
--exclude-by-longname TEXT Excludes tests/tasks or suites by longname.
--version Show the version and exit.
--help Show this message and exit.
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:
--tags / --no-tags Show the tags that are present. [default:
no-tags]
--full-paths / --no-full-paths Show full paths instead of releative.
[default: no-full-paths]
--diagnostics / --no-diagnostics
Display `robot` parsing errors and warning
that occur during discovering. [default:
diagnostics]
--by-longname TEXT Select tests/tasks or suites by longname.
--exclude-by-longname TEXT Excludes tests/tasks or suites by longname.
--version Show the version and exit.
--help Show this message and exit.
robotcode language-server¶
Run Robot Framework Language Server.
Usage:
robotcode language-server [OPTIONS] [PATHS]...
Options:
--stdio Run in `stdio` mode. (Equivalent to `--mode
stdio`) *NOTE:* This option is mutually
exclusive with options: tcp, socket, mode,
pipe, port, pipe-name, bind.
--tcp [<ADDRESS>:]<PORT> 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: socket,
mode, pipe, port, pipe-name, stdio.
--socket [<ADDRESS>:]<PORT> Run in `socket` mode and connect to the
given port. (Equivalent to `--mode socket
--port <port>`) *NOTE:* This option is
mutually exclusive with options: tcp, mode,
pipe, port, pipe-name, stdio.
--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: tcp,
socket, mode, port, pipe-name, stdio, bind.
--mode [socket|stdio|tcp|pipe] The mode to use for the debug launch server.
*NOTE:* This option is mutually exclusive
with options: socket, stdio, tcp, pipe.
[default: stdio]
--port PORT The port to listen on or connect to. (Only
valid for `tcp` and `socket mode`) *NOTE:*
This option is mutually exclusive with
options: pipe-name, pipe. [default: 6610;
1<=x<=65535]
--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-name, pipe. [default:
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, socket, pipe, port,
stdio, bind.
--version Show the version and exit.
--help Show this message and exit.
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:
--version Show the version and exit.
--help Show this message and exit.
robotcode new¶
TODO: Create a new Robot Framework project.
TODO: This is not implemented yet.
Usage:
robotcode new [OPTIONS]
Options:
--help Show this message and exit.
robotcode profiles¶
View robot profile informations.
Usage:
robotcode profiles [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
- list: Lists the defined profiles in the current robot configuration.
- show: Shows the given robot profile.
robotcode profiles list¶
Lists the defined profiles in the current robot configuration.
Usage:
robotcode profiles list [OPTIONS] [PATHS]...
Options:
--help Show this message and exit.
robotcode profiles show¶
Shows the given robot profile.
Usage:
robotcode profiles show [OPTIONS] [PATHS]...
Options:
-n, --no-evaluate Don't evaluate expressions in the profile.
--help Show this message and exit.
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:
--version Show the version and exit.
--help Show this message and exit.
robotcode robot¶
Runs robot with the selected configuration, profiles, options and arguments.
The options and arguments are passed to robot as is.
Examples:
robotcode run
Usage:
robotcode robot [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...
Options:
--by-longname TEXT Select tests/tasks or suites by longname.
--exclude-by-longname TEXT Excludes tests/tasks or suites by longname.
--version Show the version and exit.
--help Show this message and exit.
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:
--version Show the version and exit.
--help Show this message and exit.