Usage - GeekyAnts/ga-wdio GitHub Wiki

Creator Command:

ga-wdio create --help
# Usage: create [options]

# Creates the boilerplate in the present directory

# Options:
#  -h, --help  output usage information

# Examples:
#  ga-wdio create

Run Command:

For Web:

ga-wdio run:web --help
# Usage: run [options]

# Runs the testing scripts with the options / stacks specified

# Options:
#  -s, --stack <local> <browser-stack> <browser-stack-local>  runs your tests on the local system or browser-stack (default: "local")
#  -b, --browser <chrome> <firefox>                           web browser [chrome or firefox] (default: "chrome")
#  -m, --mode [headless]                                      sets the mode to the run web-browser, this feature is applicable only with local stack (default: "head")
#  -h, --help                                                 output usage information

# Examples:
#  ga-wdio run . 							# Imp Note: This command will set all the default values
#  ga-wdio run --stack=local --browser=chrome --mode=headless
#  ga-wdio run --stack=browser-stack --browser=firefox

For API:

ga-wdio run:api --help
# Usage: run:api [options]

# [For API] Runs the testing scripts with the options specified

# Options:
#   -h, --help  output usage information

# Examples:
#   ga-wdio run:api

For iOS Mobile:

ga-wdio run:ios --help
# Usage: run:ios [options]

# [For Mobile] Runs the testing scripts on iOS platform

# Options:
#  -b, --browser <true>                               enables the mobile's browser testing (default: "false")
#  -s, --stack <browser-stack>                        runs your tests on environments like browser-stack or local simulator (default: "local")
#  -h, --help                                         output usage information

# Examples:
#   ga-wdio run:ios # Imp Note: This command will set all the default values
#   ga-wdio run:ios --browser=true
#   ga-wdio run:ios --stack=browser-stack

For Android Mobile:

# ga-wdio run:android --help
# Usage: run:android [options]

# [For Mobile] Runs the testing scripts on Android platform

# Options:
#   -b, --browser <true>         enables the mobile's browser testing (default: "false")
#   -s, --stack <browser-stack>  runs your tests on environments like browser-stack or local simulator (default: "local")
#   -h, --help                   output usage information

# Examples:
#   ga-wdio run:android # Imp Note: This command will set all the default values
#   ga-wdio run:android --browser=true
#   ga-wdio run:android --stack=browser-stack

Check Command:

ga-wdio check:appium --help
# Usage: check:appium [options]

# [For Mobile] Checks the necessary & optional dependencies for appium

# Options:
#   -h, --help  output usage information

Upload Command:

ga-wdio upload:app --help
# Usage: upload:app [options]
# Returns: app_url, custom_id & shareable_id

# Uploads IPA or APK file to browser stack & returns the app url with custom ID

# Options:
#   -f, --file </path/to/file>  runs your tests on the local system or browser-stack
#   -u, --username <username>   browser-stack username
#   -p, --password <password>   browser-stack password
#   -c, --customId <MyApp>      your custom ID for the app
#   -h, --help                  output usage information

# Examples:
#   ga-wdio upload:app --file=/path/to/file --username=faizahmed --password=somethingsecret --customId=MyApp
⚠️ **GitHub.com Fallback** ⚠️