> For the complete documentation index, see [llms.txt](https://cyr1en.gitbook.io/commandprompter/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cyr1en.gitbook.io/commandprompter/getting-started/arguments/prompt-argument.md).

# Prompt Argument

Prompt arguments affect one prompt. A normal inline tag has this shape:

```
<key:filter:Display text flags>
```

The key and filter are optional. Flags are whitespace-delimited tokens; text such as `cost-int` is not interpreted as `-int`.

## Prompt keys

* Empty key: [Chat](/commandprompter/prompts/chat-prompt.md)
* `a:`: [Anvil UI](/commandprompter/prompts/anvil-ui-prompt.md)
* `s:`: [Sign UI](/commandprompter/prompts/sign-ui-prompt.md)
* `p:`: [Player UI](/commandprompter/prompts/player-ui-prompt.md)
* `d:`: [Dialog UI](/commandprompter/prompts/dialog-ui-prompt.md)
* `c:`, `confirm:`, `confirmation:`: [Confirmation](/commandprompter/prompts/confirmation-prompt.md)
* `i:`, `item:`: [Item Selector](/commandprompter/prompts/item-selector-prompt.md)

Keys configured in `screen-mappings` (`prompt-config.yml`) route to their configured screen type. Plugins may register [custom keys](/commandprompter/developers/custom-screens.md). An unresolved key fails closed and aborts the command; it does not fall back to Chat.

## Flags

| Flag                       | Meaning                                                                                                                                                                    |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `-ds`                      | Disables session sanitation. Normal sanitation removes legacy color codes plus braces, brackets, angle brackets, parentheses, dollar signs, section signs, and ampersands. |
| `-iv:<alias>`              | Applies a validator from `prompt-config.yml`. See [Input Validation](/commandprompter/features/input-validation.md).                                                       |
| `-int`                     | Requires a signed 32-bit Java integer.                                                                                                                                     |
| `-str`                     | Requires a nonblank string.                                                                                                                                                |
| `-timeout:<seconds>`       | Overrides this prompt's timeout; accepted range is 1–3600.                                                                                                                 |
| `-breakIf:<condition>`     | Cancels the flow after this answer when an answer-only condition is true. See [Command Flows](/commandprompter/features/command-flows.md#early-termination-with-breakif).  |
| `-t`                       | Shows the prompt's display text as an on-screen title before opening the prompt.                                                                                           |
| `-t:Main`                  | Uses a custom main title.                                                                                                                                                  |
| `-t:"Main Title"\|Sub\|70` | Uses a main title, subtitle, and duration in ticks. Quote values that contain spaces.                                                                                      |
| `-t:"Main"\|\|70`          | Sets the main title and duration while omitting the subtitle.                                                                                                              |

The title duration defaults to 70 ticks. Title flags work with every inline prompt and apply to an entire compound dialog block. The title delay counts against that prompt's `Prompt-Timeout`.

## Preset prompts

Use `<@id>` to load a prompt from `presets.json`. Preset IDs are case-sensitive and cannot contain spaces. Inline flags appended to a preset reference are ignored; configure `title_display`, `sanitize`, and other options in the preset itself. Preset `sanitize` values are honored (`"sanitize": false` preserves color codes and symbols in answers).

## Escaping delimiters

Prefix a configured opening or closing delimiter with a backslash to keep it literal. With the default delimiters, write `\<` or `\>`. CommandPrompter removes that escape when assembling the command.

## Example

```
/nick <Who should be renamed? -str> <a:New name -ds -t:"Choose a name"||50>
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cyr1en.gitbook.io/commandprompter/getting-started/arguments/prompt-argument.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.