CLI reference

Overview#

This document describes the Capter CLI commands, arguments, and options.

Calling capter will show you information about subcommands, but has no functionality itself.

USAGE:
capter <SUBCOMMAND>
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
test run tests

You can add --help to any command to see the available options and arguments.

Commands#

test#

Running capter test will run any available workflow that the CLI can find in your project.

USAGE:
capter test [FLAGS] [OPTIONS] [INPUT]
FLAGS:
-d, --debug
--dry-run skip posting the run to the webhook
-h, --help Prints help information
--skip-git don't pass any git information to the webhook
-V, --version Prints version information
OPTIONS:
--timeout <SECONDS> how long to wait for a connection
-t, --token <TOKEN> pass a token with the webhook request
-w, --webhook <URL> post the run to a url after completion
ARGS:
<INPUT> Glob pattern where to look for tests [default: {.capter,capter}/**/*.yml]

Options#

Optiondescription
--token, -tIf you are using the capter.io service, pass in your project token. This will automatically send the run report to Capter. If you post to a custom webhook, this token will be passed in the query like ?token={token} so you can use it to authorize the call.
--webhook, -wThe CLI will make a POST request with the run report to this URL. If you pass in a --token but no webhook, it will use the capter.io webhook.
--timeoutSet the request timeout in seconds.

Flags#

Flagdescription
--debug, -dRun the CLI in debug mode.
--dry-runStops the CLI from posting to the webhook, even if it's set.
--skip-gitStops the CLI from sending the sha, commit message , and branch name to the webhook.