Skip to main content

Capter CLI

Capter is a lightweight end-to-end testing tool for APIs. It's language agnostic and can test APIs written in any language (Node.js, Go etc).

  • ๐Ÿง‘โ€๐Ÿ’ป Write tests in YAML
  • ๐Ÿ”Ž Run the same tests locally, in CI, or as a cron job to monitor your live APIs
  • ๐Ÿƒโ€โ™‚๏ธ Takes less than a minute to get started

How it works#


Capter workflows are YAML files where you write your tests:

# ./capter/health.yml
name: health check
- name: check /health
- !expect status to_equal 200

The example above is very small and doesn't do much. Have a look at the get started guide to learn how to add more steps, assertions and how to compose advanced requests.

The Capter CLI#

When you run the CLI, it will look for workflows in the .capter/ folder and run them sequentially.

$ capter test