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.

The Ghostly CLI (@ghostly-io/cli) is the single entry point for every local operation: generating credentials, wiring up the Cursor MCP server, launching the testing engine, and keeping everything up to date. Once installed globally, the ghostly binary (and its legacy ghost alias) give you full control of your local Ghostly environment from any directory.

​
Installation

Install the CLI globally from npm. Node.js 20 or later is required. 
npm install -g @ghostly-io/cli
Confirm the installation succeeded: 
ghostly --version
The ghost binary is registered alongside ghostly as a legacy alias — both resolve to the same entry point. 
ghost --help   # identical to ghostly --help
The ghost alias exists for backwards compatibility. New scripts and documentation should use ghostly.

​
Commands

CommandDescription
ghostly keygenGenerate or rotate the API key stored in ~/.ghostly/auth.json
ghostly installWrite credentials, inject the MCP server into Cursor, install Chromium, and copy Cursor rules
ghostly configSet the LLM provider, model, and API key for AI-assisted test mode
ghostly upMigrate the database, seed the admin user, and start the API + dashboard
ghostly updateUpgrade the globally installed CLI to the latest published version

​
The ~/.ghostly/auth.json file

All persistent configuration lives in a single JSON file at ~/.ghostly/auth.json. It is created by ghostly install and written with mode 0600 (owner-read-only). Its structure is: 
{
  "apiKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "apiUrl": "http://localhost:4000",
  "llm": {
    "provider": "http",
    "model": "gpt-4o",
    "apiKey": "sk-...",
    "baseUrl": "https://api.openai.com/v1/chat/completions"
  },
  "extraEnv": {}
}
apiKey and apiUrl are mandatory. The llm block is optional and only required when using AI-assisted mode. extraEnv is an escape hatch for injecting arbitrary environment variables into the engine process.
1

Install the CLI

npm install -g @ghostly-io/cli
2

Run the interactive installer

ghostly install
Writes credentials, injects the MCP server into ~/.cursor/mcp.json, installs Chromium, and copies Cursor rules and skills.
3

Configure the AI provider

ghostly config
Optional, but required for assisted test generation. Choose between Cursor Agent CLI or any OpenAI-compatible HTTP endpoint.
4

Start the engine

ghostly up
Migrates the database, seeds the admin user, and starts the API and dashboard on http://localhost:4000.

​
Command pages

keygen

Generate or rotate the API key in ~/.ghostly/auth.json

install

Interactive setup for MCP, Chromium, and Cursor rules

config

Set the LLM provider and credentials for assisted mode

up

Start the local testing engine and dashboard

update

Upgrade to the latest published CLI version

​
System requirements

RequirementVersion
Node.js>=20
CursorAny recent version (for MCP integration)
ChromiumInstalled automatically by ghostly install

Build docs developers (and LLMs) love

Get started for freeTalk to us