---
title: The ghostex command
description: Control Ghostex from any terminal, or let your agents do it.
---

Ghostex installs a command called `ghostex`. You can use it from any terminal, and your agents use it to control Ghostex for you.

## Handy commands

| Command                                            | What it does                                                |
| -------------------------------------------------- | ----------------------------------------------------------- |
| `ghostex ls`                                       | List your running sessions.                                 |
| `ghostex f`                                        | Search every prompt you've sent to an agent.                |
| `ghostex attach`                                   | Open a session in this terminal, even over SSH.             |
| `ghostex open <path>`                              | Open a file or folder in Ghostex.                           |
| `ghostex guide`                                    | Print the Ghostex guide (the same one Ask Ghostex reads).   |
| `ghostex accounts`                                 | Show every Claude and Codex account with its usage.         |
| `ghostex orchestrator status --orchestrator <ref>` | Show an [orchestrator](/workflows/orchestrators)'s threads. |
| `ghostex settings list`                            | Show every setting and its value.                           |
| `ghostex settings set <key> <value>`               | Change a setting.                                           |
| `ghostex --help`                                   | See every command.                                          |

`gx` is a shorter name for the same command.

## Sessions and files

| Command                                      | What it does                                                          |
| -------------------------------------------- | --------------------------------------------------------------------- |
| `ghostex terminal`                           | Open a Quick terminal, with no project.                               |
| `ghostex edit <file>`                        | Open a file in the Code view. `--goto <file>:<line>` jumps to a line. |
| `ghostex previous-sessions`                  | List closed sessions you can bring back.                              |
| `ghostex restore-previous-session`           | Bring a closed session back.                                          |
| `ghostex sleep <session>` / `wake <session>` | Put a session to sleep, or wake it.                                   |
| `ghostex export-transcript <session>`        | Save a session's conversation as a Markdown file.                     |
| `ghostex wait-for-text <session> <pattern>`  | Wait until a session prints a line that matches.                      |
| `ghostex notify --title <text>`              | Post to the notifications bell.                                       |

## Setup and upkeep

| Command                                   | What it does                                                                      |
| ----------------------------------------- | --------------------------------------------------------------------------------- |
| `ghostex agent-cli status`                | Check, install or update your agents' CLIs. See [Agents](/customize/agents).      |
| `ghostex app-update status`               | Check for, install, or auto-install Ghostex updates, here or on another computer. |
| `ghostex work-mode` / `ghostex workspace` | [Workspaces and Work mode](/views/work).                                          |
| `ghostex connectors`                      | [Connectors](/customize/connectors) for your apps.                                |
| `ghostex extensions --help`               | Browse and install extensions.                                                    |
| `ghostex feedback send`                   | File a bug report. See [Report a bug](/feedback).                                 |
| `ghostex bundle`                          | Save Ghostex's state, logs and a screenshot for a bug report.                     |

## Let agents drive Ghostex

With the **Ghostex CLI** skill installed (Settings > Integrations), agents can start other agents, send them messages, read their output, manage the Kanban board and automations, and change settings. You just ask in plain words, like "start a Codex session on the api project and ask it to fix the failing test".

The skill teaches agents to read `ghostex --help` before they act, so they use the commands your version actually has, and to check the result afterwards. For some jobs it hands over to a more specific skill, like [Ghostex Agents](/workflows/multi-agent) or [Ghostex Browser Use](/skills/browsers-and-apps). See [Agent skills](/skills/overview) for the full list.

:::tip[Ask Ghostex]
Try "What can I do with the ghostex command?"
:::