Welcome to CLEM

CLEM builds and runs REST API tests as flows: a list of steps (requests, code and pauses) that run top to bottom, pass values to each other and check every answer. Run them in the app, hand them to CI as plain Node.js scripts, or let an AI client build them for you.

The CLEM window: the left menu, a flow of six steps in the middle and the run log on the right
The tutorial flow after a run: steps in the middle, the log of the run on the right.

What you can do with it

Where to start

Getting startedInstall CLEM, learn the window and build a first flow in five minutes. TutorialA complete API test: login, token, create / update / delete, checks, environments, CI. RequestsEverything a request step can send, and how to try one before running the flow. ChecksTurn requests into tests: status, time, headers, JSON paths, XPath and schemas. EnvironmentsOne flow, many targets: dev, staging and prod. Export and CIRun flows headless in Jenkins, GitHub Actions, GitLab or Azure DevOps.

Example flows

Every page that teaches a feature comes with an example flow you can open and run. They use free public test APIs, dummyjson.com and httpbin.org, so they need internet access but no account.

The flows below are in your workspace as the project Help: open one with Load Flow. A second project, Examples, has a numbered walk through every feature. The installer adds both (Windows: a checkbox, on by default; Linux and macOS: on the first start), and Help → Add the example projects adds them any time: see The example projects.

FlowWhat it showsPage
first-requestOne request and two checksGetting started
tutorialLogin, Bearer token, create / update / delete, a request in a loop, cleanup, environmentsTutorial
checksEvery kind of check, assertion helpersChecks
code-loopsRetries, a request in a loop, shared variablesCode blocks
always-runCleanup that runs after a failureAlways run
authBasic, Bearer, API keyAuth
graphqlA GraphQL query with variablesGraphQL
filesMultipart upload, download, files in codeFiles
cookiesStarting cookies, Set-Cookie, the cookies helperCookies
data-drivenOne run per row of a CSV fileData-driven runs

A few words used everywhere

WordMeaning
FlowA test: steps, variables, functions and settings, saved as one .clem.json file.
StepOne thing a flow does: a request, a code block or a delay.
ProjectA folder of flows that share environments, secrets and files.
VariableA named value such as $baseUrl, written anywhere a request has text.
CheckA rule on a response (status 200, $.id exists…). A failed check fails its step.
RunOne execution of a flow, with its log, and optionally a report.

In the app, the ? next to a panel's title opens the page of this guide about that panel. The Help button on the left lists every page.