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

# Commands & permissions

Commands, keys and staff permissions of Cuxial Garages, and what the admin panel can do.

Cuxial Garages adds six commands: two for players and officers, four for staff. Everything else happens at the markers and in the admin panel.

## Commands

| Command              | Who                                          | What it does                                                                                                                                                                              |
| -------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `/garageadmin`       | Staff with the `admin.permission` permission | Opens the admin panel.                                                                                                                                                                    |
| `/impound`           | Jobs listed in `data/impound.lua` → `jobs`   | Opens the impound form for the nearest vehicle, within `maxDistance`.                                                                                                                     |
| `/givekey [id]`      | Everyone                                     | Hands the key of the nearest vehicle to the player with that server id. Without an id, to the nearest player within 5 metres. You need the key, and the other player must be next to you. |
| `/adminkey [plate]`  | Staff in the ACE group                       | Creates a key for that plate. Inside a vehicle, it uses the plate of that vehicle.                                                                                                        |
| `/carwipe [seconds]` | Staff in the ACE group, server console       | Starts a vehicle cleanup after a countdown. Without a number it uses `countdown` from `data/carwipe.lua`.                                                                                 |
| `/cancelwipe`        | Staff in the ACE group, server console       | Cancels the cleanup in progress.                                                                                                                                                          |

{% hint style="info" %}
`[id]`, `[plate]` and `[seconds]` are optional. The names of `/impound`, `/givekey`, `/adminkey`, `/carwipe` and `/cancelwipe` can be changed in their `data` files. `/garageadmin` is fixed.
{% endhint %}

## Keys

| Key          | What it does                                                                                                                                     |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <kbd>E</kbd> | At a marker on foot: opens the garage, depot or rental point. Driving: stores the vehicle, returns a job vehicle or returns a rental. Fixed key. |
| <kbd>L</kbd> | Locks or unlocks the nearest vehicle you have the key for. Default from `keybinds.toggleLocks`.                                                  |
| <kbd>G</kbd> | Turns the engine on or off from the driver seat. Default from `keybinds.toggleEngine`.                                                           |
| <kbd>H</kbd> | Searches for keys in a vehicle you have no key for, from the driver seat. Default from `keybinds.searchKeys`.                                    |

<kbd>L</kbd>, <kbd>G</kbd> and <kbd>H</kbd> are defaults. Each player can rebind them in the GTA key settings.

While placing a garage from the admin panel:

| Key                  | What it does                                                  |
| -------------------- | ------------------------------------------------------------- |
| <kbd>E</kbd>         | Places the access point or the parking spot at your position. |
| Mouse wheel          | Rotates the parking spot.                                     |
| <kbd>Enter</kbd>     | Finishes the current phase.                                   |
| <kbd>Backspace</kbd> | Undoes the last spot, or cancels.                             |
| <kbd>X</kbd>         | Adds another access point to the same garage.                 |

## Items

| Item                        | Use                                                                                 |
| --------------------------- | ----------------------------------------------------------------------------------- |
| Vehicle key                 | Using it from the inventory locks or unlocks its vehicle when it is nearby.         |
| Lockpick, advanced lockpick | Using one next to a locked vehicle starts a skill check. Success unlocks the doors. |
| Rental contract             | Using it opens the receipt of that rental while it is active.                       |

With `ox_target` running, aiming at a player while standing next to a vehicle you have the key for shows the option to give them that key.

## Permissions

| Feature                         | Requirement                                                                                 |
| ------------------------------- | ------------------------------------------------------------------------------------------- |
| Admin panel and all its actions | The permission in `admin.permission` (`'admin'` by default), checked through your framework |
| `/adminkey`                     | ACE group `group.<admin.permission>` (`group.admin` by default), plus the permission above  |
| `/carwipe`, `/cancelwipe`       | ACE group in `data/carwipe.lua` → `adminAce` (`group.admin` by default)                     |
| `/impound`                      | A job listed in `data/impound.lua` → `jobs`                                                 |
| Releasing vehicles at a depot   | A job on the job list of that depot. Depots with no list use `data/impound.lua` → `jobs`    |
| Job garage                      | Having that job. Each fleet vehicle can ask for a minimum grade                             |

To put a staff member in the ACE group:

{% code title="server.cfg" %}

```cfg
add_principal identifier.license:xxxxxxxxxxxxxxxx group.admin
```

{% endcode %}

## Admin panel

`/garageadmin` opens a panel with six tabs.

| Tab      | What you do there                                                                                                                                                       |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Garages  | Create, edit and delete public, house and gang garages: id, name, vehicle categories, transfer price, transfers to players and capacity.                                |
| Jobs     | Create job garages: the job, the fleet (model, minimum grade, livery, extras) and the extras menu.                                                                      |
| Depots   | Create impound depots and choose which jobs can release vehicles there.                                                                                                 |
| Rental   | Create rental points: class (ground, air, sea or mixed), duration buttons, maximum hours and the catalogue with price per hour, deposit, stock and licence per vehicle. |
| Vehicles | Search every owned vehicle. Give a new vehicle to a player, move one to another garage, impound it or delete it.                                                        |
| Players  | Search players and see the vehicles of each one.                                                                                                                        |

Points are placed in game. The panel closes, you walk to the spot and place the access point and the parking spots with a ghost vehicle, and the garage is saved when you finish. A garage can have several access points, each with its own parking spots.

{% hint style="info" %}
Staff actions are overrides. They remove the vehicle from the world if it was out, and they ignore garage capacity.
{% endhint %}


---

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