> 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/cozyranks/commands.md).

# Commands

## Commands

### Player Commands

| Command       | Permission      | Description                      |
| ------------- | --------------- | -------------------------------- |
| `/ranks`      | `cozyranks.use` | Opens the active rank goal menu. |
| `/ranks list` | `cozyranks.use` | Opens the rank path menu.        |

### Admin Commands

Use `/ranksadmin` as the preferred admin command. Confirmed aliases are `/cozyadmin` and `/cozyranksadmin`.

| Command                                      | Permission        | Description                                                                                                      |
| -------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------- |
| `/ranksadmin <player>`                       | `cozyranks.admin` | Opens the read-only admin inspect GUI for a player. Console cannot open this GUI.                                |
| `/ranksadmin reload`                         | `cozyranks.admin` | Reloads config, messages, tiers, ranks, migration config, and admin menu config.                                 |
| `/ranksadmin info <player>`                  | `cozyranks.admin` | Shows a player's rank state, active goal, progress, and recent history.                                          |
| `/ranksadmin list`                           | `cozyranks.admin` | Prints the configured rank ladder and costs.                                                                     |
| `/ranksadmin set <player> <rank> [--silent]` | `cozyranks.admin` | Force-sets a player's rank. `--silent` skips on-claim commands and target notification.                          |
| `/ranksadmin reset <player> [--confirm]`     | `cozyranks.admin` | Wipes rank state and deposits. Without `--confirm`, it shows a warning.                                          |
| `/ranksadmin refund <player> [--confirm]`    | `cozyranks.admin` | Returns pending deposits for the active goal and clears those deposits. Without `--confirm`, it shows a warning. |
| `/ranksadmin sync <player>`                  | `cozyranks.admin` | Re-dispatches the player's current rank to LuckPerms.                                                            |
| `/ranksadmin sync all`                       | `cozyranks.admin` | Re-dispatches stored ranks to LuckPerms for all players with a rank.                                             |
| `/ranksadmin migrate dry-run`                | `cozyranks.admin` | Scans legacy groups and writes a migration report.                                                               |
| `/ranksadmin migrate execute [--confirm]`    | `cozyranks.admin` | Applies the migration plan. Without `--confirm`, it previews the plan and warning.                               |
| `/ranksadmin fixdeposits`                    | `cozyranks.admin` | Reruns the internal rank-id deposit recovery migration.                                                          |

### Examples

<table><thead><tr><th width="383.875">Example</th><th>What It Does</th></tr></thead><tbody><tr><td><code>/ranks</code></td><td>Opens the player's active goal menu.</td></tr><tr><td><code>/ranks list</code></td><td>Opens the rank path menu.</td></tr><tr><td><code>/ranksadmin Steve</code></td><td>Opens the read-only admin inspect GUI for Steve.</td></tr><tr><td><code>/ranksadmin info Steve</code></td><td>Shows Steve's rank state and history.</td></tr><tr><td><code>/ranksadmin set Steve gold_i --silent</code></td><td>Sets Steve to <code>gold_i</code> without on-claim commands or target notification.</td></tr><tr><td><code>/ranksadmin reset Steve --confirm</code></td><td>Resets Steve's rank state and deposits.</td></tr><tr><td><code>/ranksadmin refund Steve --confirm</code></td><td>Refunds Steve's pending deposits for the active goal.</td></tr><tr><td><code>/ranksadmin sync Steve</code></td><td>Re-dispatches Steve's current rank to LuckPerms.</td></tr><tr><td><code>/ranksadmin migrate dry-run</code></td><td>Scans legacy groups and creates a report.</td></tr></tbody></table>

### Notes

* `/rankup` is not registered in `plugin.yml`.
* `/ranksadmin <player>` is a special inspect shortcut only when the first argument is not a known subcommand.
* Tab completion suggests admin subcommands, online player names, and configured rank IDs where relevant.


---

# 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/cozyranks/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.