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

# Commands & permissions

Commands of Cuxial Multichar, who can use them and how staff permissions work.

Every command name can be changed in `shared/config.lua`. These are the defaults.

## Commands

| Command                            | Who                                           | What it does                                                                                                                             |
| ---------------------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `/logout`                          | Staff (`group.admin`)                         | Sends you back to the character selection                                                                                                |
| `/logoutplayer [id]`               | Staff (`group.admin`) and server console      | Sends another player back to the character selection. `id` is the server ID of the player                                                |
| `/partnerinvite [target] [type]`   | Everyone                                      | Invites a nearby player to appear with you in the selection. `target` is their server ID. `type` is `cp` (couple) or `bff` (best friend) |
| `/forcepartner [citizenid] [type]` | Staff (`group.admin`)                         | Sets your partner by citizenid, without an invitation. Same `type` values                                                                |
| `/height`                          | Minor characters with growth enabled by staff | Opens the height panel                                                                                                                   |

{% hint style="info" %}
`/partnerinvite` needs the other player within 10 metres, and they have 60 seconds to answer. A player can send 3 invitations per minute. The three values are in the `partner` block of the config. With `partner.enabled = false`, `/partnerinvite` and `/forcepartner` do not exist.
{% endhint %}

### Optional command

`vehicles.spotCommand` is disabled by default. Give it a name and the command copies your current position as a `vec4` to the clipboard. It is meant for filling `data/vehicle_locations.lua`.

{% code title="shared/config.lua" %}

```lua
vehicles = {
    enabled = true,
    resource = "cuxial_garages",
    spotCommand = "mcspot",
},
```

{% endcode %}

## Keys

Cuxial Multichar registers no key bindings.

## Permissions

Staff commands use the `restricted` field of each command. It is an ACE group, checked by `ox_lib`. The permission of `/forcepartner` is in `partner.commands.force`.

{% code title="shared/config.lua" %}

```lua
commands = {
    logout = { name = "logout", restricted = "group.admin" },
    logoutPlayer = { name = "logoutplayer", restricted = "group.admin" },
},
```

{% endcode %}

To give a player that group:

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

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

{% endcode %}

Set `restricted = false` to open a command to every player.

{% hint style="warning" %}
The exports that approve minor characters do not check permissions. The resource that calls them must do it. See [Exports & events](/scripts/core/cuxial-multichar/developers.md).
{% 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-multichar/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.