> For the complete documentation index, see [llms.txt](https://docs.cozycrafters.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cozycrafters.net/plugin-docs/cozyguides/commands.md).

# Commands

## Commands

### Player Commands

| Command                   | Aliases                     | Permission           | Who Uses It | Description                                                             |
| ------------------------- | --------------------------- | -------------------- | ----------- | ----------------------------------------------------------------------- |
| `/guides`                 | None documented in source   | `cozyguides.use`     | Player      | Opens the guide browser GUI.                                            |
| `/guides list`            | None documented in source   | `cozyguides.use`     | Player      | Lists available guides in chat.                                         |
| `/guides start <guideId>` | None documented in source   | `cozyguides.use`     | Player      | Starts a guide directly by guide ID.                                    |
| `/guides quit`            | None documented in source   | `cozyguides.use`     | Player      | Quits the active guide if that guide allows player quitting.            |
| `/welcome`                | `/welcomeguide`, `/starter` | `cozyguides.welcome` | Player      | Opens the configured welcome checklist when welcome support is enabled. |

### Admin Commands

| Command                                | Aliases                             | Permission                | Who Uses It      | Description                                                                     |
| -------------------------------------- | ----------------------------------- | ------------------------- | ---------------- | ------------------------------------------------------------------------------- |
| `/cozyguides list`                     | `/cguides list`                     | `cozyguides.admin`        | Admin or console | Lists loaded guide IDs and names.                                               |
| `/cozyguides reload`                   | `/cguides reload`                   | `cozyguides.admin.reload` | Admin or console | Reloads config, messages, and guide files, then cancels active sessions safely. |
| `/cozyguides start <guideId> <player>` | `/cguides start <guideId> <player>` | `cozyguides.admin.start`  | Admin or console | Force-starts a loaded guide for an online player.                               |
| `/cozyguides stop <player>`            | `/cguides stop <player>`            | `cozyguides.admin.stop`   | Admin or console | Force-stops an online player's active guide.                                    |

### Internal Commands

These commands are registered by the plugin for clickable guide buttons. They are not meant to be typed manually.

| Command                   | Permission               | Who Uses It                   | Description                                     |
| ------------------------- | ------------------------ | ----------------------------- | ----------------------------------------------- |
| `/cozyguidesnext <token>` | Not documented in source | Player, through guide buttons | Advances a guide session using a session token. |
| `/cozyguidesquit <token>` | Not documented in source | Player, through guide buttons | Quits a guide session using a session token.    |

### Examples

| Example                           | What It Does                          |
| --------------------------------- | ------------------------------------- |
| `/guides`                         | Opens the guide menu.                 |
| `/guides list`                    | Shows available guides in chat.       |
| `/guides start homes-basics`      | Starts the bundled homes guide.       |
| `/welcome`                        | Opens the welcome checklist.          |
| `/cozyguides list`                | Shows all loaded guide IDs and names. |
| `/cozyguides start welcome Steve` | Starts the `welcome` guide for Steve. |
| `/cozyguides stop Steve`          | Stops Steve's active guide.           |

### Notes

* `/guides` and `/welcome` can only be used by players.
* Admin commands can be run by a permitted player or by console.
* The `/cozyguides` root command has `cozyguides.admin` in `plugin.yml`, and its subcommands also check the permissions listed above.
* A guide can also define its own guide-specific permission in its guide file. No bundled guide-specific permission is set in the provided guide files.


---

# 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:

```
GET https://docs.cozycrafters.net/plugin-docs/cozyguides/commands.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.