Documentation Index
Fetch the complete documentation index at: https://docs.getlark.ai/llms.txt
Use this file to discover all available pages before exploring further.
Prefer to run Lark from an AI coding agent? See Agents for Claude Code, Cursor, and other Skills-compatible tools.
Create your first workflow
Open the workflows page
In the dashboard, go to Workflows. Click Create workflow to add a new one. Describe what you want to test
Write your test in plain English. For example, “Log in and verify the dashboard loads” or “Call the API and check the response.” No code required.
Choose how the workflow runs
- Deterministic (i.e. scripted) - The AI writes a script that runs the same steps every time. Lark keeps the test updated as your product changes (e.g. UI updates).
- AI-driven - The AI performs the test from scratch each run, deciding how to achieve the goal. Best for complex flows like “follow the integration quickstart and verify it works.”
Add secrets if needed
If the test needs credentials (API keys, login credentials, etc.), attach a secret context. Otherwise you can skip this. Run the workflow
Hit Run. The workflow runs in a sandbox environment. When it finishes, you’ll see the result and any artifacts (screenshots, videos, logs).
Make sure you have Node.js 18+ and your API key set:export GETLARK_API_KEY=your-api-key
Create a workflow
npx -y @getlark/cli workflows create \
--name "New User Signup" \
--description "Go to dashboard url and verify that you can sign up as a new user." \
--mode deterministic
- Deterministic — The AI writes a script that runs the same steps every time. Lark keeps the test updated as your product changes (e.g. UI updates).
- AI-driven (default) — The AI performs the test from scratch each run, deciding how to achieve the goal. Best for complex flows.
See the CLI reference for all options.Add secrets if needed
If the test needs credentials, create a secret context in the dashboard and attach it with --secret-contexts:npx -y @getlark/cli workflows create \
--name "User Login" \
--description "Go to the dashboard and verify you can login to the dashboard." \
--mode deterministic \
--secret-contexts dashboard_login
Run the workflow
npx -y @getlark/cli workflows invoke --all --wait
--wait flag blocks until the run finishes. When it completes you’ll see the result in your terminal. View results
After the run completes, open it in the dashboard to see:
- Summary - Pass/fail and high-level outcome
- Steps - What the agent did (and, for AI-driven runs, how it chose to do it)
- Logs - Detailed agent output
- Artifacts - Screenshots, recordings, and other generated files
Next, run the same workflow from CI so it runs on every PR or deploy, or drive workflows directly from AI coding agents like Claude Code and Cursor.