llmx/docs/prompts.md

Custom Prompts

Custom prompts turn your repeatable instructions into reusable slash commands, so you can trigger them without retyping or copy/pasting. Each prompt is a Markdown file that LLMX expands into the conversation the moment you run it.

Where prompts live

• Location: store prompts in $CODEX_HOME/prompts/ (defaults to ~/.llmx/prompts/). Set CODEX_HOME if you want to use a different folder.
• File type: LLMX only loads .md files. Non-Markdown files are ignored. Both regular files and symlinks to Markdown files are supported.
• Naming: The filename (without .md) becomes the prompt name. A file called review.md registers the prompt review.
• Refresh: Prompts are loaded when a session starts. Restart LLMX (or start a new session) after adding or editing files.
• Conflicts: Files whose names collide with built-in commands (like init) stay hidden in the slash popup, but you can still invoke them with /prompts:<name>.

File format

• Body: The file contents are sent verbatim when you run the prompt (after placeholder expansion).

• Frontmatter (optional): Add YAML-style metadata at the top of the file to improve the slash popup.

  ---
  description: Request a concise git diff review
  argument-hint: FILE=<path> [FOCUS=<section>]
  ---
  

  • description shows under the entry in the popup.
  • argument-hint (or argument_hint) lets you document expected inputs, though the current UI ignores this metadata.

Placeholders and arguments

• Numeric placeholders: $1–$9 insert the first nine positional arguments you type after the command. $ARGUMENTS inserts all positional arguments joined by a single space. Use $$ to emit a literal dollar sign (LLMX leaves $$ untouched).
• Named placeholders: Tokens such as $FILE or $TICKET_ID expand from KEY=value pairs you supply. Keys are case-sensitive—use the same uppercase name in the command (for example, FILE=...).
• Quoted arguments: Double-quote any value that contains spaces, e.g. TICKET_TITLE="Fix logging".
• Invocation syntax: Run prompts via /prompts:<name> .... When the slash popup is open, typing either prompts: or the bare prompt name will surface /prompts:<name> suggestions.
• Error handling: If a prompt contains named placeholders, LLMX requires them all. You will see a validation message if any are missing or malformed.

Running a prompt

1. Start a new LLMX session (ensures the prompt list is fresh).
2. In the composer, type / to open the slash popup.
3. Type prompts: (or start typing the prompt name) and select it with ↑/↓.
4. Provide any required arguments, press Enter, and LLMX sends the expanded content.

Examples

Draft PR helper

~/.llmx/prompts/draftpr.md

---
description: Create feature branch, commit and open draft PR.
---

Create a branch named `tibo/<feature_name>`, commit the changes, and open a draft PR.

Usage: type /prompts:draftpr to have llmx perform the work.