Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,30 @@ Return invoice_id, customer, due_date, amount, status, and detail_url. Pause if
need to sign in, never ask me to paste credentials into chat, and do not change
any records.
```

## Run a Natural-Language Workflow

For direct CLI use, configure Gemini in the shell without putting the key in the
repository:

```powershell
$env:GEMINI_API_KEY = "your-new-key"
```

Then provide the goal. Webcmd asks Gemini for a validated workflow, creates a
browser Session, runs the browser steps, and carries returned values between
steps:

```powershell
npm run dev -- workflow run --goal "Find the OB Fitness Challenge on Site A and submit its details on Site B"
```

Inspect the generated workflow without opening a browser:

```powershell
npm run dev -- workflow run --goal "Find the OB Fitness Challenge on Site A and submit its details on Site B" --plan-only -f json
```

Use `--session <id>` when continuing an existing authenticated Session, and use
`--keep-session` when the automatically created Session should remain available
after the workflow finishes.
42 changes: 1 addition & 41 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
"./download/progress": "./dist/src/download/progress.js",
"./fetch/command": "./dist/src/fetch/command.js",
"./pipeline": "./dist/src/pipeline/index.js",
"./planner": "./dist/src/planner/index.js",
"./planner/gemini": "./dist/src/planner/gemini.js",
"./plugin-runtime": "./dist/src/plugin-runtime.js",
"./hosted/availability": "./dist/src/hosted/availability.js",
"./hosted/core-commands": "./dist/src/hosted/core-commands.js",
Expand All @@ -53,6 +55,7 @@
"scripts": {
"benchmark": "uv run python benchmarks/scripts/run_eval.py",
"dev": "tsx src/main.ts",
"ui": "tsx src/workflow-ui-server.ts",
"dev:bun": "bun src/main.ts",
"build": "npm run clean-dist && npm run copy-yaml && npm run compile && npm run build-manifest",
"compile": "tsc --build && node -e \"require('fs').chmodSync('dist/src/main.js', 0o755)\"",
Expand Down Expand Up @@ -96,6 +99,7 @@
"access": "public"
},
"dependencies": {
"@google/genai": "^2.10.0",
"@mozilla/readability": "^0.6.0",
"cli-table3": "^0.6.5",
"cloakbrowser": "0.4.5",
Expand All @@ -114,7 +118,6 @@
"devDependencies": {
"@emnapi/core": "^1.11.2",
"@emnapi/runtime": "^1.11.2",
"@google/genai": "^2.10.0",
"@types/js-yaml": "^4.0.9",
"@types/jsdom": "^27.0.0",
"@types/node": "^25.5.2",
Expand Down
Loading