Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Meza-dev/Ghostly/llms.txt

Use this file to discover all available pages before exploring further.

ghostly install is the interactive setup wizard that prepares everything Ghostly needs to run on your machine. It is the first command you should run after installing the npm package, and it is safe to run again after updating — each step is idempotent and checks for existing configuration before making changes.

​
What it does

The installer walks through four sequential steps:
1

Generate or reuse the API key

Reads ~/.ghostly/auth.json if it already exists. If an apiKey is present it is reused; otherwise a new UUID v4 key is generated automatically (equivalent to running ghostly keygen). The resulting credentials are written to ~/.ghostly/auth.json with mode 0600.
2

Inject the MCP server into Cursor

Reads ~/.cursor/mcp.json and injects the Ghostly MCP server entry. If a Ghostly entry already exists you are prompted to confirm before overwriting. Declining leaves the existing MCP configuration untouched.
3

Install Chromium

Checks whether Chromium is already available via Playwright. If it is not, you are prompted to install it. Accepting runs npx playwright install chromium automatically. You can always install it manually later if you skip this step.
4

Copy Cursor rules and skills

Copies the bundled Ghostly rule file to ~/.cursor/rules/ghosttester-expert-architect.mdc and the skills directory to ~/.cursor/skills/ghosttester-expert-architect/. Files that already exist are not overwritten.

​
Flags

​
--api-url
string
default:"http://localhost:4000"
Backend URL written to ~/.ghostly/auth.json and embedded in the MCP server configuration. Change this if you run the Ghostly engine on a non-default port.

​
Usage

ghostly install
With a custom backend port: 
ghostly install --api-url http://localhost:8080

​
After installation

Once install completes, the terminal displays a summary of next steps: 
✅  Instalación completada correctamente.

  Próximos pasos:
  • Iniciar servicios locales:   ghostly up
  • Actualizar el CLI:           ghostly update
  • Documentación:               https://ghostly.dev/docs
The two recommended follow-up commands are:
  1. ghostly config — configure your AI provider (required for assisted test mode).
  2. ghostly up — start the local engine and dashboard.
You can also set the ASSIST_LLM_API_KEY environment variable as an alternative to running ghostly config — the engine picks it up automatically on startup.
The MCP server is loaded from a compiled entry point bundled inside the CLI package. If ghostly install reports that the MCP entry point is missing, the installed version of @ghostly-io/cli is incomplete. Run ghostly update (or npm install -g @ghostly-io/cli@latest) to reinstall the full package, then run ghostly install again.
If Ghostly is already listed in ~/.cursor/mcp.json, the installer will ask whether you want to overwrite it. Answer No to keep your existing MCP config, or Yes to replace it with the configuration from the current CLI version — useful after updating.

​
Files written

FilePurpose
~/.ghostly/auth.jsonAPI key and engine configuration
~/.cursor/mcp.jsonCursor MCP server registry
~/.cursor/rules/ghosttester-expert-architect.mdcCursor rule for Ghostly-aware completions
~/.cursor/skills/ghosttester-expert-architect/Cursor skill bundle for test generation

Build docs developers (and LLMs) love

Get started for freeTalk to us