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 up is the command that brings the Ghostly engine to life. It prepares the local SQLite database, generates the Prisma client, seeds the default admin account on a first run, and then starts the combined API and static web frontend as a long-running process. The terminal stays attached — press Ctrl+C to shut everything down cleanly.

​
Prerequisites

~/.ghostly/auth.json must exist before running ghostly up. If it does not, the command exits immediately with an error and prompts you to run ghostly install first.

​
What it does internally

1

Read credentials

Reads ~/.ghostly/auth.json and converts it into environment variables (GHOST_API_KEY, GHOST_API_URL, ASSIST_LLM_*, etc.) for the child process.
2

Apply schema migrations

Runs prisma db push --skip-generate --accept-data-loss against the local SQLite database at ~/.ghostly/ghostly.db. Creates the database file if it does not exist yet.
3

Generate the Prisma client

Runs prisma generate --schema schema.prisma locally so that the bundled Prisma client matches the current schema. This step is required every time the CLI is updated.
4

Seed the admin user

On a brand-new database only, runs the bundled seed script to create the default admin account. This step is skipped on subsequent starts.
FieldValue
Emailadmin@ghostly.local
Passwordadmin123
5

Start the API and dashboard

Spawns the API server as a child process with NODE_ENV=production. The web dashboard is served as static files from the same process. The engine runs on http://localhost:{port} (default 4000).

​
Flags

​
-p, --port
number
default:"4000"
Port the API and dashboard listen on. The health check endpoint and dashboard URL are both derived from this value.

​
Usage

ghostly up

​
Terminal output

After all preparation steps complete, the engine prints its status summary: 
✅  Ghostly en ejecución

  Servicios:
  • Dashboard + API:   http://localhost:4000
  • Healthcheck:       http://localhost:4000/health

  Acceso inicial (seed):
  • Email:             admin@ghostly.local
  • Password:          admin123

  Presiona Ctrl+C para detener.

​
Health check

The /health endpoint returns HTTP 200 when the engine is ready. Use it for scripted readiness polling: 
curl http://localhost:4000/health

​
AI-assisted mode

If no LLM is configured in auth.json and neither ASSIST_LLM_API_KEY nor OPENAI_API_KEY is set in the environment, the engine emits a warning but starts normally. Assisted test generation will be unavailable until you run ghostly config. When the cursor-cli provider is configured, the engine logs Modo asistido: Cursor Agent CLI (auth local) instead of the warning.

​
Graceful shutdown

Ctrl+C sends SIGINT to the CLI process, which forwards the signal to the child server. If the child does not exit within 1.5 seconds, SIGKILL is sent to force termination. The SIGTERM signal is handled identically — useful for process managers and container runtimes.
The default admin password (admin123) is intentionally simple for local development. Change it from the dashboard settings immediately if you expose the engine on a non-loopback address or in any non-development environment.
If ghostly up reports that the API bundle is missing, the CLI was installed from an incomplete build. Run ghostly update to fetch the full package and try again.

Build docs developers (and LLMs) love

Get started for freeTalk to us