The example projects
CLEM comes with ready-made flows in two projects. Examples walks through CLEM feature by feature, one numbered flow each. Help holds the flows this guide's pages use and show in their pictures. Open one, run it, read its steps, and copy what you need into your own flows.
Where they are
In your workspace, as the projects Examples and Help: Load Flow → Examples or Help. The same files are in the examples/Examples and examples/Help folders next to this guide.
Getting the projects
- Windows: the installer has a page Example flows with Add the example projects (Examples and Help) to my workspace, ticked by default. CLEM adds both projects when it first starts.
- Linux and macOS: CLEM adds both projects the first time it starts.
- Any time later: Help on the left → Add the example projects. It adds whichever of the two is missing, so this is also how you get one back after deleting it.
An upgrade never adds or changes the projects: your copies stay as you left them. A new version often comes with new example flows. To get them, open Help and click Update the example projects. It replaces the example flows, environments.json, secrets.json and the example files of both projects with this version's. Your changes to them are lost, but other flows and files you added are kept.
To change an example, save it to one of your own projects first (Save As), so an update can't overwrite your work.
Running them
The flows use free public test APIs, mainly dummyjson.com and httpbin.org, so they need internet access but no account. Each flow's description (at the top of the run log) says what it shows; most steps have a name that says what they check.
| Good to know | Why |
|---|---|
| 19_secrets asks for a value | The Examples project has one secret, $demoKey. Secret values are never shipped: adding the project stores a demo value on this computer, encrypted. If the computer can't encrypt values (Linux without a keyring), or the value was removed, set any text in Secrets (the lock in the title bar) and run it again. See Secrets. |
| 13_flow_settings fails on purpose | It shows a request timeout with Continue running after a failed step: one step fails and the later ones still run. |
| 23_run_time_limit fails on purpose | It polls a job that never finishes; the flow's Run time limit stops it after 15 s. |
| The environments | Help: dev / staging (the tutorial: different users of dummyjson.com). Examples: httpbin / httpbingo (12_environments: the same requests against two echo services, httpbin.org and the open-source go-httpbin at httpbingo.org). Each flow remembers the one it uses. |
| Run them all | Open any flow of a project and pick Run project from the Run button's menu. Every flow of that project runs, and the log links each one's report. See Running, logs and reports. |
The flows
The numbered flows are in Examples and walk through CLEM feature by feature. The named ones are in Help; each belongs to a page of this guide.
| Flow | What it shows | Read more |
|---|---|---|
| 01_http_methods | Every HTTP method: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS | Requests |
| 02_params_and_headers | Query parameters, URL encoding, custom headers | Requests |
| 03_body_modes | JSON, form, XML, multipart and file bodies | Requests |
| 04_checks_catalogue | Every check target and its operators, without code | Checks |
| 05_extract_and_chain | Extract rules, a login → token → call chain | Variables and extraction |
| 06_auth_types | Flow auth, Basic, Bearer, API key (header and query), a wrong password | Auth |
| 07_loop_retry_delay | Retry until a status, delays | Code blocks and loops |
| 08_redirects_and_http_versions | Following redirects or not, HTTP/1.1 and HTTP/2 | Proxy, certificates and HTTP/2 |
| 09_cookies | Starting cookies, the cookie jar, deleted cookies | Cookies |
| 10_save_responses | Saving responses to files, only when the status is 2xx | Files |
| 11_data_driven | One run per row of a CSV file | Data-driven runs |
| 12_environments | The same requests against two environments | Environments |
| 13_flow_settings | Timeout, Continue on error, Fail requests on a 4xx / 5xx status (fails on purpose) | Flow Settings |
| 14_conditionals_and_cleanup | Run conditionals and an Always run cleanup step | Always run |
| 15_code_blocks | Code blocks, assertion helpers, requests in code | Code blocks and loops |
| 16_functions_and_libraries | A library and Functions built on it | Functions and libraries |
| 17_graphql | Queries, variables, several operations, a mutation | GraphQL |
| 18_data_from_json | One run per row of a JSON file, with numbers, booleans and lists | Data-driven runs |
| 19_secrets | A project secret, masked in the log and reports | Secrets |
| 20_response_viewers | The JSON, XML, HTML and image viewers, a large list, binary responses in code | Files |
| 21_server_sent_events | Server-sent events: a stream the server ends, then stop after a count, a time or a stop event; Events checks; a stream read in code | Server-sent events |
| 22_fhir | Testing a FHIR R4 API (HL7 FHIR) against the public HAPI FHIR test server: CapabilityStatement, create, read, update, search by identifier (a Bundle), an OperationOutcome for an invalid resource, delete as an Always run cleanup | Requests |
| 23_run_time_limit | The Run time limit stops a polling loop that never ends (fails on purpose) | Run time limit |
| 24_websocket | WebSocket: wait for the greeting, send, stop after a count, a stop text or a time; Messages checks; a connection driven from code; a connection kept open, a REST call, and Wait for Message on the event (ntfy.sh) | WebSocket |
| first-request | One request and two checks | Getting started |
| tutorial | Login, Bearer token, create / update / delete, a request in a loop, cleanup, environments | Tutorial |
| checks | Every kind of check, assertion helpers | Checks |
| code-loops | Retries, a request in a loop, shared variables | Code blocks |
| always-run | Cleanup that runs after a failure | Always run |
| auth | Basic, Bearer, API key | Auth |
| graphql | A GraphQL query with variables | GraphQL |
| sse | Three events from a live stream, checked and listed | Server-sent events |
| websocket | A WebSocket round trip, checked; the same server from code; a REST call and the event it sends (Wait for Message) | WebSocket |
| files | Multipart upload, download, files in code | Files |
| cookies | Starting cookies, Set-Cookie, the cookies helper | Cookies |
| data-driven | One run per row of a CSV file | Data-driven runs |
What else is in the projects
| File | What it holds |
|---|---|
| Examples/environments.json | httpbin, httpbingo |
| Help/environments.json | dev, staging |
| Examples/secrets.json | The names of the project's secrets ($demoKey), never their values. Adding the project gives each one without a value a demo value, encrypted on this computer |
Examples/files/ | Uploads and data files: customers.csv, payload.json, products.json, data/users.csv |
Help/files/ | Uploads and data files: avatar.png, logins.csv |
AI clients connected to CLEM can add the projects too: the MCP tool clem_install_examples (see AI access).