import { CoPilotClient } from "@ghostrider/sdk";
const client = new CoPilotClient("ws://127.0.0.1:4201/ws/agent");
await client.connect();
await client.highlight("#submit-btn", { label: "Review this action" });Developer quickstart
The shortest truthful path from repo to visible agent interaction.
This page is a marketing-friendly bridge into the real docs: enough to evaluate quickly, without drifting away from what the repository actually supports today.
1. Verify the workspace
Start with the commands that prove the repo is healthy.
cargo check --workspace
cargo test --workspace
cd packages/sdk && npm test
cd ../overlay && npm test
cd ../extension && node --test tests/*.test.js2. Start the runtime
Run the combined MCP server and relay locally.
cargo run --bin ghostrider-mcp -- --port 4201 --dev
This starts the relay at ws://127.0.0.1:4201/ws/agent and exposes the MCP tool surface.
3. Try the main surfaces
Use whichever integration style matches your evaluation flow.
import { CoPilotOverlay, CoPilotProvider } from "@ghostrider/overlay";
from ghostrider import GhostRiderClient
async with GhostRiderClient("ws://127.0.0.1:4201/ws/agent") as client:
await client.highlight("#submit-btn", label="Review this action")ghostrider-cli monitor ws://127.0.0.1:4201/ws/agent
ghostrider-cli send ws://127.0.0.1:4201/ws/agent clearCurrent reality
Use honest evaluation language from day one.
Strongest today
Web overlays, relay-driven sessions, MCP tooling, and macOS accessibility are the clearest, strongest story.
Experimental edges
Linux and Windows accessibility modules exist but are not the default production path yet.
Good bridge
Use this page as the short path, then send developers into the actual docs for implementation detail.
Bridge to docs
Go from marketing quickstart into the technical references.
These are the best next pages once someone wants the repo-truth view.