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

# Commands & permissions

Commands, keys, ranks and the full permission list of Cuxial Admin.

Cuxial Admin has three commands. Everything else is done from the panel, and each action is checked on the server against the rank of whoever asks for it.

## Commands

| Command        | Who                                          | What it does                                                                                               |
| -------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `/admin`       | Staff                                        | Opens the panel. Anyone without a rank gets a notice instead.                                              |
| `/report`      | Everyone                                     | Opens the report window. The first message creates the report; the rest continue the conversation.         |
| `/staffreload` | Server console, or staff with `staff.manage` | Reloads ranks and staff from the database and rebuilds the item, vehicle, job and gang lists of the panel. |

The three names can be changed in `commands` of `shared/config.lua`.

{% hint style="info" %}
A player is only recognised as staff once a character is loaded. On the character selection screen nobody has a rank.
{% endhint %}

## Keys

| Key                 | What it does                                                                                                                     |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| <kbd>U</kbd>        | Opens the panel. Default from `keybinds.panel`.                                                                                  |
| <kbd>End</kbd>      | Toggles noclip. Default from `keybinds.noclip`.                                                                                  |
| <kbd>Left Alt</kbd> | With the panel open, releases the cursor so you can walk while the panel stays on screen. Press it again to return to the panel. |

God mode, invisibility, infinite ammo, super jump, blips and names have no default key. Each staff member assigns them in the GTA key settings, under FiveM. The report window has no key unless you set `keybinds.report`.

## How ranks work

A rank is a name plus a list of permissions. There are three ways to hold one, and the most specific wins:

| Scope        | Given to     | Applies to                      |
| ------------ | ------------ | ------------------------------- |
| Character    | A citizenid  | That character only             |
| Discord      | A Discord ID | Every character of that account |
| Discord role | A role ID    | Anyone holding that role        |

* A character rank beats a Discord rank, and a Discord rank beats a role rank. This lets a staff member keep one character without powers.
* The Discord scope needs the player to have Discord linked to FiveM.
* The Discord role scope needs the external web panel service, which reports who holds each role. Without it, use the other two scopes.
* When someone holds several role ranks, the highest one applies.

### Starting ranks

Created on first start from `data/permissions.lua`. Edit, add or delete them from the panel.

| Rank       | Remote access | Permissions                                                                                                                                                                  |
| ---------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Superadmin | Yes           | Everything (`*`)                                                                                                                                                             |
| Admin      | Yes           | Players, vehicles, inventory, sanctions, reports, minors, teleport and personal tools; registry and server view; world, announcements and cleanup                            |
| Moderator  | No            | View, revive, heal, freeze, effects, warn, kick, community service and spectate; teleport; noclip, invisibility, blips and names; reports; view minors, sanctions and server |
| Support    | No            | View players and sanctions; view, claim and reply to reports                                                                                                                 |

### Rules when managing staff

These apply to anyone with `staff.manage`:

* You can only grant a rank whose permissions you hold yourself.
* You can only create or edit a rank with permissions you hold yourself.
* You cannot change or remove someone's rank when that rank has permissions you do not hold.
* You cannot remove your own rank.
* A rank cannot be deleted while someone still has it.

## Permissions

A permission is written as `group.action`. Two wildcards exist: `*` grants everything and `group.*` grants a whole group, for example `player.*`.

### Panel

| Permission      | Allows                              |
| --------------- | ----------------------------------- |
| `player.view`   | See the player list                 |
| `sanction.view` | See the sanctions history           |
| `registry.view` | See the audit log and the rank list |
| `server.view`   | See the server tab                  |
| `staff.manage`  | Manage staff and ranks              |

### Players

| Permission         | Allows                                                                   |
| ------------------ | ------------------------------------------------------------------------ |
| `player.revive`    | Revive a player, yourself or everyone within a radius                    |
| `player.reviveAll` | Revive the whole server                                                  |
| `player.heal`      | Heal                                                                     |
| `player.freeze`    | Freeze and unfreeze                                                      |
| `player.effects`   | Effects: drunk, fire and others                                          |
| `player.kill`      | Kill                                                                     |
| `player.clothes`   | Open the appearance editor for a player                                  |
| `player.screen`    | View a player's screen. Also needs the `cuxial_admin_screen_owners` list |
| `player.ped`       | Change the model                                                         |
| `player.job`       | Give a job                                                               |
| `player.gang`      | Give a gang                                                              |
| `player.money`     | Give money                                                               |
| `player.warn`      | Warn                                                                     |
| `player.kick`      | Kick                                                                     |
| `player.service`   | Give and remove community service                                        |
| `player.ck`        | Character kill. Deletes the character; a reason is required              |
| `player.spectate`  | Spectate                                                                 |

### Inventory

| Permission          | Allows                    |
| ------------------- | ------------------------- |
| `inventory.open`    | Open a player's inventory |
| `inventory.give`    | Give items                |
| `inventory.clear`   | Empty an inventory        |
| `inventory.stash`   | Open nearby stashes       |
| `inventory.vehicle` | Open glovebox and trunk   |

### Vehicles

| Permission       | Allows                                                           |
| ---------------- | ---------------------------------------------------------------- |
| `vehicle.spawn`  | Spawn a vehicle                                                  |
| `vehicle.give`   | Give a vehicle to a player as owner                              |
| `vehicle.fix`    | Repair and refuel                                                |
| `vehicle.mod`    | Upgrade                                                          |
| `vehicle.plate`  | Change the plate                                                 |
| `vehicle.keys`   | Take the keys of the nearest vehicle                             |
| `vehicle.delete` | Delete the vehicle you are in, or the empty ones within a radius |

### Teleport

| Permission        | Allows                                 |
| ----------------- | -------------------------------------- |
| `teleport.self`   | Go to coordinates or to the map marker |
| `teleport.player` | Go to a player and bring players       |

### Reports

| Permission     | Allows                            |
| -------------- | --------------------------------- |
| `report.view`  | See the inbox and the transcripts |
| `report.claim` | Claim a report                    |
| `report.reply` | Reply                             |
| `report.close` | Close                             |

### Minors

| Permission      | Allows                       |
| --------------- | ---------------------------- |
| `family.view`   | See minor character requests |
| `family.review` | Approve or reject them       |

### Personal

| Permission          | Allows                         |
| ------------------- | ------------------------------ |
| `self.noclip`       | Noclip                         |
| `self.godmode`      | God mode                       |
| `self.invisible`    | Invisibility                   |
| `self.infiniteAmmo` | Infinite ammo                  |
| `self.superJump`    | Super jump                     |
| `self.blips`        | Player blips on the map        |
| `self.names`        | Names above players            |
| `self.adminCar`     | Staff vehicle                  |
| `self.clothes`      | Appearance editor for yourself |
| `self.copyCoords`   | Copy coordinates               |

### Server

| Permission        | Allows                                  |
| ----------------- | --------------------------------------- |
| `server.world`    | Time, weather, time freeze and blackout |
| `server.announce` | Announcements                           |
| `server.cleanup`  | Entity cleanup                          |

{% hint style="info" %}
The panel issues warnings and kicks. Bans are issued from txAdmin and then appear in the sanctions history.
{% endhint %}

Cuxial Admin does not use ACE permissions. Access depends only on the rank.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.cuxial.com/scripts/core/cuxial-admin/commands.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.