Commit Graph

58 Commits

Author SHA1 Message Date
asensagent a42d58d92b docs: comprehensive audit fix for CLI 1.0.0–1.4.2 (#520)
* docs: comprehensive audit fix for CLI 1.0.0–1.4.2

Align docs/ and skills/ with CLI actual state after 1.0.0→1.4.2 changes.

P0 — broken examples fixed:
- quickstart.mdx: add --session/--tab, use start+goto instead of open
- index.mdx: replace search→get→operate flow with start→snapshot→automate
- api-reference/cli.mdx: remove search/get sections, add full browser
  command reference with --session/--tab on all commands
- guides/browser.mdx: add --session/--tab to Local Mode examples,
  replace search→get recommended workflow with snapshot-based workflow
- guides/cli-and-skills.mdx: add --session/--tab, update skill workflow
  from search→get→operate to start→snapshot→automate

P1 — missing flags and commands:
- command-reference.md: add --provider/-p, --stealth/--no-stealth,
  --header, --session to start; add --wait-until to goto; add --by-ref
  to select; add --no-isolate, pre-context fields, structured error
  details to eval; add --screenshot-format, --selector to screenshot;
  add hermes target and --browser to setup; remove --executable-path
- SKILL.md: add missing commands to Observation row (viewport, attr,
  attrs, box, styles, describe, state, inspect-point, pdf) and
  Interaction row (focus, drag, upload, eval, mouse-move,
  cursor-position); add cloud provider workflow section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: restore search/get references per review feedback

Keep actionbook search and actionbook get sections in docs — they will
be adjusted later. Restores search/get to api-reference/cli.mdx,
index.mdx, browser.mdx recommended workflow, and cli-and-skills.mdx
core commands and skill workflow. The --session/--tab fixes on browser
commands remain.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: add select diagnostic output to command-reference

Document that `browser select` now returns structured diagnostics
(available values, visible texts, match mode, total count) when an
option is not found (PR #521).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-14 15:18:28 +08:00
sen df22a1ec40 docs: remove deprecated actionbook app documentation (#515)
[docs]chore: remove deprecated actionbook app documentation

The `actionbook app` (Electron desktop automation) feature was removed
during the CLI rewrite from TypeScript to Rust (v1.0.0+). The MDX
documentation was never cleaned up, causing users to encounter
"unknown command" errors when following the docs.

Removed:
- docs/guides/app-use.mdx (entire file)
- actionbook app section from docs/api-reference/cli.mdx
- Navigation entry from docs/docs.json
2026-04-13 20:39:56 +08:00
sen 94c7e2bea7 docs: update browser automation guide with cloud providers and CLI alignment (#514)
* [docs]docs: add cloud provider documentation for browser automation

- Add Cloud mode to Modes table and new Cloud Providers section in browser.mdx
- Add browser start/restart commands and expanded global flags in cli.mdx
- Add cloud provider tip in installation.mdx

* [docs]fix: align browser.mdx commands with actual CLI implementation

- Rename mode: Isolated → Local (matches Mode::Local enum)
- Fix command names: tab list → list-tabs, session list → list-sessions,
  wait-nav → wait navigation, wait-idle → wait network-idle,
  wait-fn → wait condition, hotkey → press, console → logs console,
  inspect → inspect-point, storage → local-storage/session-storage
- Remove 7 non-existent commands: fetch, batch, switch-frame, emulate,
  fingerprint, connect, info
- Fix argument order: fill/type use [selector] value (selector first)
- Fix coordinate format: mouse-move/inspect-point use comma x,y
- Fix flag: --full-page → --full for screenshot
- Fix cookies: session-level only (no --tab flag)
- Remove non-existent --ref and --human flags
- Remove non-existent -S short flag (use --session)
- Add --session/--tab to all per-tab command examples
- Restructure: add Session Lifecycle and Wait Conditions sections

All 47 documented commands verified against actionbook v1.4.1.

* [docs]refactor: reorder sections, remove stale content, polish wording

- Reorder: Local Mode → Cloud Providers → Extension Mode (by stability)
- Add "under active development" note on Extension mode
- Remove deprecated upgrade tip (v0.2.0 migration)
- Remove extension serve/stop mention
- Remove Risk Levels section (internal implementation detail)
- Simplify Extension Security to single paragraph
- Replace all em dashes with natural punctuation
- Simplify Session Lifecycle examples

* [docs]fix: remove unsupported -S shorthand from cli.mdx global flags

Address PR review comment: CLI only supports --session (long form),
no -S short alias exists.
2026-04-13 20:12:01 +08:00
asensagent 32035a7a91 docs: update OpenClaw integration guide (#498)
* docs: update OpenClaw integration guide

- Install section: npm only, removed InstallTabs snippet
- Step 2: removed smoke test (actionbook search)
- Step 3: removed "search -> get -> operate" workflow reference
- Next Steps: updated card description

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: revert steps 2-3 changes, keep only npm install update

Only the installation section should change per updated request.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* docs: update InstallTabs snippet to npm-only install

Update the shared install-tabs.mdx snippet to only show npm install
method. Reverts inline change to openclaw.mdx — keeps the import.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-04-11 12:57:07 +08:00
mcfn.feng 342a78a51c [root]docs: restore docs.json nav entry and openclaw.mdx lost in revert 72aac42
Also restores:
- docs/docs.json: re-add api-reference/evaluate-api navigation entry
- docs/openclaw.mdx: restore OpenClaw plugin integration content
2026-04-03 08:38:24 +08:00
mcfn.feng bd8c9767e7 [root]docs: restore deleted evaluate-api.mdx
Restores docs/api-reference/evaluate-api.mdx that was accidentally
removed in revert commit 72aac42.
2026-04-03 08:35:02 +08:00
mcfn.feng 58545129de [root]refactor: remove actionbook-rs, promote cli-v2 to packages/cli
- Delete packages/actionbook-rs/ (legacy 0.x CLI)
- Delete old packages/cli/ (JS npm wrapper for 0.x)
- Rename packages/cli-v2/ → packages/cli/ (git mv)
- Merge npm wrapper files (bin/actionbook.js, scripts/postinstall.js) into new cli/
- Update package.json: name → @actionbookdev/cli, private → false, add npm distribution fields
- Update sync-versions.js: point Cargo.toml/Cargo.lock sync at packages/cli/
- Update release.yml: build from packages/cli/ instead of packages/actionbook-rs/
- Update test.yml: paths and working-directory from cli-v2 → cli
- Update CLAUDE.md, CONTRIBUTING.md, docs, issue templates
- Delete stale changeset (fix-screenshot-timeout.md)
- Keep 6 platform binary packages unchanged
2026-04-02 00:46:12 +08:00
AlexZ 0949311c2e [docs]fix: mark CDP-only commands in browser automation guide
Address Codex review feedback on PR #235 — extension-mode users would
hit runtime errors copying examples for wait-idle, console, fetch,
emulate, and switch-frame. Add [CDP] inline markers and section-level
<sup>CDP</sup> tags so the limitation is visible before users try.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-20 01:57:01 +08:00
AlexZ 8d3aa994bc [docs]fix: correct fill command argument order (text first, selector second)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-20 01:57:01 +08:00
AlexZ 509f3fd8ae [docs]docs: comprehensive browser automation guide with multi-session
- Rename page from "Browser Modes" to "Browser Automation"
- Add multi-session section: -S flag usage, session management, 3 common mistake patterns
- Document all 44 browser subcommands (was ~20, now complete)
- New sections: file upload, fetch (one-shot), batch actions, advanced features
- Expand page interaction: type, hotkey, scroll, wait-idle, wait-fn
- Expand debug & export: pdf, snapshot flags, console, info, viewport, inspect
- Add cookie & storage operations, tab management with full subcommands
- Simplify shutdown section, add restart command

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-20 01:57:01 +08:00
sen 2bff3f9b75 [docs]fix: adjust skill-based guidance wording per review feedback
Soften the "no prompt injection" claim to avoid mismatch with current
plugin implementation that still uses before_prompt_build.
2026-03-19 13:53:56 +08:00
sen e0a5ebcecc [docs]docs: rewrite openclaw guide for native plugin integration
Replace CLI + Skills indirect setup with @actionbookdev/openclaw-plugin
native installation via `openclaw plugins install`, gateway config, and
skill-based agent guidance.
2026-03-19 13:45:55 +08:00
Adcent 963dc903d4 [root]chore: remove private build pipeline workspaces 2026-03-17 16:36:01 +08:00
sen 7372b285b0 docs: refresh dify plugin guide 2026-03-15 23:59:49 +08:00
sen f14d139e64 docs: refresh dify plugin guide 2026-03-15 22:31:56 +08:00
sen d39b75fe62 [root]docs: add dify plugin documentation 2026-03-15 22:26:02 +08:00
AlexZ a35ba49827 [docs]fix: address PR #199 Codex review — correct CLI flags and arguments
- P2-1: `app attach [port]` → `app attach <target>` (required argument)
- P2-2: `--port` → `--cdp` (correct global flag for CDP port)
- P2-3: Remove invalid custom-path launch fallback; show manual
  start + attach workflow instead

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-13 18:35:51 +08:00
AlexZ 3299a0c5db [docs]feat: add actionbook app command documentation
- Add CLI reference for `actionbook app` commands (launch, attach, list, etc.)
- Add app automation guide with Electron use cases
- Update docs.json navigation structure
- Add agent prompt files to .gitignore

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-13 14:35:42 +08:00
Junliang Feng 6502eb87d8 docs: fix snippet import syntax for Mintlify (#187)
Replace unsupported <Snippet file="..."> component with standard
MDX import syntax. Mintlify requires ESM imports for reusable snippets.

Fixes install tabs not rendering on live docs site.

Affected pages:
- docs/guides/installation.mdx
- docs/quickstart.mdx
- docs/openclaw.mdx
- docs/guides/cli-and-skills.mdx
2026-03-04 17:24:16 +08:00
sen f9d0c0fd27 Merge pull request #181 from actionbook/feat/chrome-store-first-setup
feat: prefer Chrome Web Store extension setup with local fallback
2026-03-04 14:43:10 +08:00
Junliang Feng f021862187 docs: extract install tabs into reusable snippet, fix tab order (script > npm > brew > windows) (#186) 2026-03-04 07:18:44 +08:00
Junliang Feng 115233d7f8 docs: migrate install guides to brew/script-first (CUE-504) (#184)
* docs: migrate install guides to brew/script-first, keep npm (CUE-504)

* docs: keep README install simple (npm only), link to full guide

* docs: use script install in README (no Node.js dependency)

* docs: split Installation into sub-headings per platform
2026-03-04 06:06:02 +08:00
SenKe0x 52edfc69ca feat(setup): prefer Chrome Web Store extension flow with local fallback 2026-03-03 16:59:00 +08:00
adcentury b80f1991a1 docs(skill): clarify extract get-first with mechanism probes 2026-02-23 19:43:41 +08:00
adcentury be6621fc11 docs(skill): enforce extract get-first execution path 2026-02-23 19:39:17 +08:00
adcentury 8a95cd72c8 docs(skill): harden extract scroll/pagination examples 2026-02-23 19:01:07 +08:00
adcentury e29cf507ca docs(skill): fix extract pagination advance checks 2026-02-23 18:51:32 +08:00
adcentury 918c93040e docs(skill): add extract guardrails and runtime clarifications 2026-02-23 18:34:59 +08:00
adcentury 763fb0e763 docs(skill): harden extract script/runtime guidance 2026-02-23 18:31:48 +08:00
adcentury b1b2eb0910 feat(skill): add extract core skill (CUE-420)
Add new extract skill for structured data extraction from websites.
Produces executable Playwright scripts and extracted data (JSON/CSV).
Includes mechanism-aware strategies for hydration, virtualized lists,
infinite scroll, and pagination.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-23 17:35:18 +08:00
sen c70683da86 [docs]docs: simplify browser workflow and make setup-first quickstart (#147) 2026-02-19 00:50:14 +08:00
adcentury fdfd8c4533 docs: clarify installing multiple skills via interactive flow 2026-02-16 13:45:57 +08:00
adcentury cd36f834cb docs: fix skills install command guidance 2026-02-16 13:44:16 +08:00
adcentury ce5fe60712 docs: flatten docs navigation and split CLI skills (CUE-418) 2026-02-16 13:31:04 +08:00
adcentury 801c29ea2d docs: add contextual menu options (CUE-419) 2026-02-16 12:53:09 +08:00
adcentury 6148e64709 docs: hardcode Get Started URL to dashboard (CUE-416) 2026-02-15 13:48:46 +08:00
adcentury fd1a598999 docs: route Get Started button to /dashboard 2026-02-15 13:36:27 +08:00
adcentury 656fa48362 docs: point Get Started button to dashboard (CUE-416) 2026-02-15 13:35:23 +08:00
adcentury 5977a385d1 docs: simplify OpenClaw step 3 and use GitHub stars example 2026-02-15 13:27:08 +08:00
adcentury e5f4dff4e3 docs: simplify OpenClaw guide wording and title 2026-02-15 13:19:53 +08:00
adcentury d5dfd5b8ea docs: make browser-disable guidance non-destructive 2026-02-15 13:12:22 +08:00
adcentury 440bcfbeac docs: address review gaps in OpenClaw CLI guide 2026-02-15 13:10:28 +08:00
adcentury 4dc18c67e0 docs: align OpenClaw guide with CLI+setup+browser-disable flow 2026-02-15 13:08:58 +08:00
adcentury 12fee49e92 docs: make OpenClaw guide CLI + Skills only 2026-02-15 12:51:51 +08:00
adcentury f653750cda docs: add OpenClaw welcome guide (CUE-415) 2026-02-15 12:43:41 +08:00
adcentury 026a2c8ba0 chore: replace Discord links with actionbook.dev/discord (CUE-412)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-13 23:41:14 +08:00
adcentury 234142f56d revert(docs): keep Why Actionbook section unchanged 2026-02-13 08:43:42 +08:00
adcentury 2b475c7c7b docs: align core tagline with resilience-first messaging 2026-02-13 08:36:09 +08:00
Adcent 1aaa6548e8 docs: make website CLI-first and demote MCP/SDK paths (#119) 2026-02-12 10:43:34 +08:00
sen c91746d24f refactor: remove extension isolated mode, unify browser docs (#111)
* [packages/actionbook-rs]refactor: remove extension isolated mode, unify browser docs

Simplify browser architecture from three modes to two:
- Isolated (default): launches a fresh Chrome profile via CDP
- Extension: connects to the user's running Chrome via bridge

Remove extension isolated mode entirely:
- Delete isolated_extension.rs, cdp_pipe.rs, cdp_http.rs
- Remove --isolated flag from CLI and config
- Simplify extension_bridge (remove isolated file helpers)
- Simplify launcher (remove pipe transport, LaunchResult)
- Clean up setup wizard and config fields
- Add legacy .isolated file cleanup for upgrade compatibility
- Fix stop() to also resolve legacy bridge-pid.isolated

Merge browser-extension.mdx into unified browser.mdx guide:
- Single page covers both Isolated and Extension modes
- Browser commands listed once (add --extension to switch)
- Update all cross-references in docs

* [packages/actionbook-rs]fix: add liveness check to extension stop PID resolution

Previously, `extension stop` blindly preferred the standard PID file over
the legacy `.isolated` file without checking liveness. In upgrade scenarios
where the legacy file held the live bridge PID and the standard file was
stale (PID possibly reused by OS), this could send SIGTERM to an unrelated
process.

Introduce `resolve_pid_for_port()` with liveness checking:
- Same PID in both files → select safely
- Different PIDs → check liveness, pick the live one
- Both alive → refuse to kill (Ambiguous), warn user
- Both dead → clean up stale files (BothMatchedButDead)

Includes 5 unit tests covering all branches.
2026-02-11 00:10:06 +08:00