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

# Commands & permissions

Commands and keys of Cuxial License, and who can design, issue, check and revoke documents.

Cuxial License has three commands: one for staff and two for the jobs you authorize. Players need no command; they use the office NPC and their items.

## Commands

| Command              | Who             | What it does                                                                                                      |
| -------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------- |
| `/license`           | Staff           | Opens the management panel: create a card, manage the existing designs and see every licence issued.              |
| `/jobissue`          | Authorized jobs | Opens the issuing panel of the job: issue a card to a nearby player, see who holds each card, revoke and restore. |
| `/checklicense <id>` | Authorized jobs | Opens the ID check panel and scans the player with that server id.                                                |

{% hint style="info" %}
`<id>` is required. Inside the ID check panel you can also search by character identifier, which works for players who are offline.
{% endhint %}

### Issuing a card

1. The agent opens `/jobissue`, picks a nearby player and a card, and optionally an expiry date.
2. The player receives a request on screen with the name of the agent and of the card.
3. If they accept, the photo studio opens. Once they submit the photo, the item goes to their inventory and the agent is notified.

The request expires after 60 seconds. If the player declines or it runs out, nothing is issued and the agent is told.

Each character holds one record per card design. Issuing the same card again updates that record with the new dates and photo, and lifts a previous revocation.

### Revoking

Revoking does not take the item away. The card is shown with a **REVOKED** stamp, and the licence no longer appears in ID checks or in the [`GetPlayerLicenses`](/scripts/core/cuxial-license/developers.md#getplayerlicenses) export. Restoring undoes it.

## Keys

| Key                | What it does                                                                                        |
| ------------------ | --------------------------------------------------------------------------------------------------- |
| <kbd>E</kbd>       | Puts away the card you are showing. Each player can rebind it in the GTA key settings, under FiveM. |
| <kbd>Esc</kbd>     | Closes the open panel.                                                                              |
| Mouse drag / wheel | In the photo studio, moves the camera around the character and zooms.                               |

A card you show stays up for 30 seconds at most. Nearby players see it for 5 seconds.

## Permissions

| Action                                                      | Requirement                                                           |
| ----------------------------------------------------------- | --------------------------------------------------------------------- |
| Run `/license`, create, edit and delete card designs        | The framework permission in `admin.permission` (`'admin'` by default) |
| `/jobissue`, `/checklicense`, issue cards, read an ID check | A job listed in `authorizedJobs`, with its minimum grade or higher    |
| Revoke and restore                                          | Staff, a job in `authorizedJobs` or a job in `revokeJobs`             |
| See the issued licences and the nearby player list          | Staff, a job in `authorizedJobs` or a job in `revokeJobs`             |
| See your own licences                                       | Everyone                                                              |
| Buy at the licence office                                   | Everyone                                                              |
| Show a card                                                 | Everyone who carries the item                                         |

The staff permission is the one of your framework, read through `cuxial_bridge`. No ACE entry is needed in `server.cfg`.


---

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