CLI Flags Glossary

Input Flags

• --api-schema: Specify the path to your OpenAPI spec, e.g. specification/public.yaml. You can use it when generating tests for a single method or all methods specified in the schema.

• --request-data: This flag allows you to define sample data when testing a specified method. You can provide the sample request data as JSON/YAML blob directly in the command or specify a path to a file containing the sample data. Please indicate the path with an @ symbol, e.g. @data/request-data.json. If providing the JSON blob directly in the command please use apostrophes around the blob, e.g. '{"value": "skyramp"}'.

• --response-data: This flag allows you to define sample data when testing a specified method. You can provide the sample response data as JSON/YAML blob directly in the command or specify a path to a file containing the sample data. Please indicate the path with an @ symbol, e.g. @data/response-data.json. If providing the JSON blob directly in the command please use apostrophes around the blob, e.g. '{"value": "skyramp"}'.

Parameter Flags

• --auth-header: This flag allows you to specify the key of your authentication header, e.g. --auth-header X-API-KEY. By default, we assume Bearer.

• --path-params: This flag allows you to override path parameters from your endpoint URL or the pre-defined values in the API schema, e.g. --path-params id=3fa85f64-5717-4562-b3fc-2c963f66afa6.

• --query-params: This flag allows you to specify query parameters for your single method request, e.g. --query-parms limit=5.

• --form-params: You can specify form parameters instead of request-data for POST methods. However, form-params cannot be passed in combination with request-data.

Runtime flags

• --runtime: Select the environment in which you want to run the test. [local, docker]

• --docker-network: specify the name (string) of your docker network (default=bridge)

• --docker-skyramp-port: provide port number override (default=35142)

• --insecure: e.g. proceed with caution on browser. test servers that dont have certification and to proceed immediately

Output flags

• --framework:  Testing framework for generated test [playwright, pytest, robot] (default "pytest")

• --language:  Language for generated test [python, typescript] (default "python")

• --deploy-dashboard:    Deploy the Skyramp dashboard for test result collection

• --output: Allows you to specify the name of the generated test file.

• --output-dir: Allows you to specify the directory to store the generated test file.

• --overwrite: Overwrite existing tests without additional confirmation\

Load Flags

• --default-load-count: Number of times Skyramp executes the defined request [default=None]; this flag needs to be set if load-duration is not specified.

• --default-load-duration: Duration of the load test execution in seconds; this flag cannot be used in combination with default-load-count[default=5]

• --default-load-num-threads: Number of concurrent threads for load test [default=1]. Concurrent threads represent virtual users enabling you to test the vertical scalability of the service.

• --default-load-rampup-duration: Specify the duration that Skyramp incrementally increases the requests per second (RPS) until the target RPS are reached [default=None]

• --default-load-rampup-interval: Specify how often Skyramp increases the RPS until target RPS are reached [default=None]

• --default-load-target-rps: Specify the maximum RPS of the load test [default=None]