> For the complete documentation index, see [llms.txt](https://k4k3ru.gitbook.io/k4k3ru-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://k4k3ru.gitbook.io/k4k3ru-docs/agent/command-reference.md).

# Command Reference

This page lists the commands available in the released K4K3RU Agent and the authentication each command requires.

## Commands

| Command                            | Authentication              | Description                                                                                                                    |
| ---------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `/account signup`                  | Email OTP                   | Create an account and save local account state.                                                                                |
| `/account signin`                  | Email OTP                   | Restore local account state for an existing account.                                                                           |
| `/account api-key create`          | Account state and email OTP | Create an API credential. Defaults to the local `whoami@hostname` name, Ed25519, and 30 days.                                  |
| `/account api-key list`            | Local only                  | List locally stored, unexpired credentials without displaying secrets.                                                         |
| `/account app usage-balance`       | Signed request              | Display the current usage-tick balance.                                                                                        |
| `/account app list-products`       | Public                      | List active credit products one page at a time.                                                                                |
| `/markethub list-venues`           | Public                      | List configured venues and their current startup states.                                                                       |
| `/markethub list-symbols`          | Public                      | List enabled canonical symbols using the service defaults.                                                                     |
| `/markethub bbo get`               | Public request              | Select a market and source category, then retrieve a rate-limited consolidated BBO snapshot.                                   |
| `/markethub bbo subscribe`         | Signed WebSocket            | Subscribe to consolidated BBO updates.                                                                                         |
| `/markethub bbo watch`             | Local session               | Watch updates from active BBO subscriptions.                                                                                   |
| `/markethub bbo unsubscribe`       | Signed WebSocket            | Remove an active BBO subscription.                                                                                             |
| `/markethub orderbook get`         | Public request              | Select a market, source category, and depth, then retrieve a rate-limited consolidated OrderBook snapshot.                     |
| `/markethub orderbook subscribe`   | Signed WebSocket            | Subscribe to consolidated OrderBook updates.                                                                                   |
| `/markethub orderbook watch`       | Local session               | Watch updates from active OrderBook subscriptions.                                                                             |
| `/markethub orderbook unsubscribe` | Signed WebSocket            | Remove an active OrderBook subscription.                                                                                       |
| `/markethub spread get`            | Public request              | Select a symbol, quantity, threshold, route family, and source category, then retrieve a rate-limited Gross Spread evaluation. |
| `/markethub spread subscribe`      | Signed WebSocket            | Subscribe to quantity-aware cross-market Spread evaluations.                                                                   |
| `/markethub spread watch`          | Local session               | Watch economic changes from active Spread subscriptions.                                                                       |
| `/markethub spread unsubscribe`    | Signed WebSocket            | Remove an active Spread subscription.                                                                                          |
| `/payment onchain create-intent`   | Signed request              | Select an active product and create a hosted onchain payment intent.                                                           |
| `/payment onchain get-intent`      | Signed request              | Retrieve the current status and payment details of an owned intent.                                                            |
| `/exit`                            | None                        | End the Agent session.                                                                                                         |

## Interactive Controls

| Input        | Behavior                             |
| ------------ | ------------------------------------ |
| `/`          | Open hierarchical command discovery. |
| Arrow keys   | Select a command candidate.          |
| Tab or Enter | Complete the selected command.       |
| Ctrl+C       | Exit Agent.                          |

## Authentication Types

**Public** commands do not require an API credential.

**Email OTP** commands require access to the relevant email inbox and the one-time code sent by K4K3RU.

**Signed request** commands require local account state and an unexpired API credential in `~/.k4k3ru/auth.json`.

**Local only** commands read Agent state without sending a service request.

## Current Boundaries

The released Agent does not provide:

* A generic command for executing arbitrary JSON-RPC methods
* Direct connections to Venue or Broker APIs
* A loopback local API
* Persistent market-data subscription dashboards
* Autonomous opportunity detection or trading
* Order placement or other Trade Hub operations

Use the [K4K3RU API](/k4k3ru-docs/api.md) when you need to build a custom integration beyond the current Agent workflows.


---

# 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://k4k3ru.gitbook.io/k4k3ru-docs/agent/command-reference.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.
