cypress component functions #
Requires FluentCI v0.17.3 or newer. The compiler derives native WIT signatures and embedded help from these typed PureScript functions. Optional arguments may be omitted.
run #
Execute arbitrary literal CLI arguments.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
arguments |
array |
yes | Literal native CLI argument tokens, passed without shell expansion. |
Returns Contract.ExecutionResult.
version #
Print the CLI version.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
Returns Contract.ExecutionResult.
setup #
Install the test framework in project using Bun. Browser binaries are installed separately with install.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
version |
string |
no | Framework version or release tag to install with Bun. Default: "latest". |
Returns Contract.ExecutionResult.
test #
Run Cypress specs headlessly, returning a failure if any tests fail.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
browser |
string |
no | Browser supplied to the cypress test operation. |
config-file |
string |
no | Config File supplied to the cypress test operation. |
config |
string |
no | Named configuration selected by the native tool. |
spec |
string |
no | RPM spec file inside the package tree. |
reporter |
string |
no | Reporter supplied to the cypress test operation. |
reporter-options |
string |
no | Reporter Options supplied to the cypress test operation. |
component |
boolean |
no | Component supplied to the cypress test operation. |
record |
boolean |
no | Record supplied to the cypress test operation. |
parallel |
boolean |
no | Maximum number of concurrent build or test jobs. |
group |
string |
no | Group supplied to the cypress test operation. |
ci-build-id |
string |
no | Ci Build Id supplied to the cypress test operation. |
tag |
string |
no | Tag supplied to the cypress test operation. |
Returns Contract.ExecutionResult.
install #
Download the Cypress binary matching the installed npm package.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
force |
boolean |
no | Force supplied to the cypress install operation. |
Returns Contract.ExecutionResult.
verify #
Verify that the installed Cypress binary can start.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
Returns Contract.ExecutionResult.
cache-list #
List installed Cypress binaries.
| Argument | Type | Required | Description |
|---|---|---|---|
project |
string |
no | Working directory containing the source checkout; defaults to the current directory. Default: ".". |
run-dir |
string |
yes | Fresh directory for this invocation’s execution report and task logs; must not already exist. |
executable |
string |
no | Native CLI executable name or absolute path; defaults to this operation’s tool. |
timeout-ms |
integer |
no | Maximum task duration in milliseconds; defaults to 900000. Default: 900000. |
artifacts |
array |
no | Output artifacts to collect as NAME=PATH entries; names must be unique. |
Returns Contract.ExecutionResult.