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

  1. 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.
  2. Linux and macOS: CLEM adds both projects the first time it starts.
  3. 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 knowWhy
19_secrets asks for a valueThe 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 purposeIt 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 purposeIt polls a job that never finishes; the flow's Run time limit stops it after 15 s.
The environmentsHelp: 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 allOpen 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.

FlowWhat it showsRead more
01_http_methodsEvery HTTP method: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONSRequests
02_params_and_headersQuery parameters, URL encoding, custom headersRequests
03_body_modesJSON, form, XML, multipart and file bodiesRequests
04_checks_catalogueEvery check target and its operators, without codeChecks
05_extract_and_chainExtract rules, a login → token → call chainVariables and extraction
06_auth_typesFlow auth, Basic, Bearer, API key (header and query), a wrong passwordAuth
07_loop_retry_delayRetry until a status, delaysCode blocks and loops
08_redirects_and_http_versionsFollowing redirects or not, HTTP/1.1 and HTTP/2Proxy, certificates and HTTP/2
09_cookiesStarting cookies, the cookie jar, deleted cookiesCookies
10_save_responsesSaving responses to files, only when the status is 2xxFiles
11_data_drivenOne run per row of a CSV fileData-driven runs
12_environmentsThe same requests against two environmentsEnvironments
13_flow_settingsTimeout, Continue on error, Fail requests on a 4xx / 5xx status (fails on purpose)Flow Settings
14_conditionals_and_cleanupRun conditionals and an Always run cleanup stepAlways run
15_code_blocksCode blocks, assertion helpers, requests in codeCode blocks and loops
16_functions_and_librariesA library and Functions built on itFunctions and libraries
17_graphqlQueries, variables, several operations, a mutationGraphQL
18_data_from_jsonOne run per row of a JSON file, with numbers, booleans and listsData-driven runs
19_secretsA project secret, masked in the log and reportsSecrets
20_response_viewersThe JSON, XML, HTML and image viewers, a large list, binary responses in codeFiles
21_server_sent_eventsServer-sent events: a stream the server ends, then stop after a count, a time or a stop event; Events checks; a stream read in codeServer-sent events
22_fhirTesting 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 cleanupRequests
23_run_time_limitThe Run time limit stops a polling loop that never ends (fails on purpose)Run time limit
24_websocketWebSocket: 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-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
sseThree events from a live stream, checked and listedServer-sent events
websocketA WebSocket round trip, checked; the same server from code; a REST call and the event it sends (Wait for Message)WebSocket
filesMultipart upload, download, files in codeFiles
cookiesStarting cookies, Set-Cookie, the cookies helperCookies
data-drivenOne run per row of a CSV fileData-driven runs

What else is in the projects

FileWhat it holds
Examples/environments.jsonhttpbin, httpbingo
Help/environments.jsondev, staging
Examples/secrets.jsonThe 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).