Commands description
deploy
Description:
Deploy your test assets to apimation cloud.
Usage:
Flags:
apimation deploy --environments - deploy only test environments with apimation cloud
apimation deploy -f, --force - deploy assets without prompting user accept
apimation deploy -h, --help - help for deploy
apimation deploy --parallel - set the flag to deploy the test assets to cloud in parallel (default true)
apimation deploy -r, --regex string - deploy test cases that match regex
Example:
apimation deploy --force
apimation deploy -r account
generate
Description:
Generate test cases, steps, sets and environment.
Usage:
Commands:
apimation generate case string -f string - generate new test case
apimation generate environment string - generate new environment
apimation generate set string - generate new set
apimation generate step string -f string - generate new test step
Flags:
apimation generate [command] -h, --help - help for generate
Example:
apimation generate case createAccount -f Feature1
apimation generate environment PROD
apimation generate set Smoke
apimation generate step Login -f Feature1
apimation generate set -h
help
Description:
Help about any command.
Usage:
apimation help
Example:
apimation help run
invite
Description:
Invite user to your apimation project.
Usage:
Flags:
apimation invite -h - help for invite
Example:
apimation invite jberzins@apimation.com
import
Description:
Import test steps, cases and load tests from OpenApi and Swagger documentation.
Usage:
Commands:
apimation import openapi - import test assets from OpenAPI file
Flags:
apimation import [command] -h, --help - help for openAPI
apimation import [command] -c, --cases - create test cases based on steps
apimation import [command] -s, --simLoads - create simulation load tests based on cases from steps. Must be used in combination with -c flag like so: -cs
apimation import [command] -s, --simLoads - create test set based on cases from steps. Must be used in combination with -c flag like so: -ct
Example:
apimation import openapi /Users/jberzins/Documents/apimation/openAPI.yaml -c
apimation import openapi /Users/jberzins/Documents/apimation/openAPI.json -cs
restore
Description:
Restore synchronised test assets from apimation cloud.
Usage:
Commands:
apimation restore cases - restore the test cases to yaml, by default restores all
apimation restore environments - restore environments to yaml, by default restores all
apimation restore sets - restore tests sets to yaml, by default restores all
apimation restore steps - restore the test steps to yaml, by default restores all
Flags:
apimation restore [command] -h, --help - help for restore
apimation restore [command] --outputPath string - lets you restore yaml files into specified path (default "./")
apimation restore [command] -r, --regex string - restores the test data to yaml based on given regex string
Example:
apimation restore cases -r account
apimation restore sets --outputPath ~/Desktop/
run
Description:
Execute created tests.
Usage:
Commands:
apimation run case string - run test case by providing the name
apimation run load - run load test scenario
apimation run set string - run test set by providing the name
Flags:
apimation run [command] -e, --environment string - test environment name for test run (default "Staging")
apimation run [command] -h, --help - help for run
Example:
apimation run case createAccount --environment Local
apimation run load loadTestCreation --environment Local
apimation run set Smoke --environment Local
apimation run case -h
user
Description:
Manage user
Usage:
Commands:
apimation user create - create new user and generate project files
Flags:
apimation user [command] -h, --help - help for user
Example:
apimation user create --email jberzins@gmail.com -p myProject
apimation user create -h
worker
Description:
Management for local Test Engine Worker
Aliases
worker, workers
Usage:
Commands:
apimation worker list - list available workers for this project
apimation worker start - start worker process
apimation worker status - get status of all locally running workers
apimation worker stop - stop and unregister local worker, add worker ID as argument to unregister other workers
Flags:
apimation worker [command] -h, --help - help for worker
apimation worker [command] --workerRoot string - directory path for testEngineWorker files
apimation worker [command] --logOnlyToFile boolean - output Apimation worker logs only to log file
Example:
apimation worker start --workerRoot /Users/jberzins/Documents/apimation/worker/