> 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/jobs/cuxial-gardener/commands.md).

# Commands & permissions

Commands, default keys and staff permissions of Cuxial Gardener.

Cuxial Gardener has two player commands and three staff commands. The job itself is played from the NPC panel and the interaction options.

## Commands

| Command             | Who               | What it does                                                                                                               |
| ------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `/gardreset`        | Crew owner        | Cancels the job in progress. Vehicles and tools are removed and nobody is paid. Not available while the job is being paid. |
| `/gardleave`        | Crew members      | Leaves the crew. The owner cannot leave while a job is in progress: reset it first.                                        |
| `/gardlist`         | Staff             | Lists the crews: number, members, region and phase. Also works from the server console.                                    |
| `/gardclose <crew>` | Staff             | Closes the crew with that number and cancels its job. The action is written to the audit table and to the Discord log.     |
| `/gardfast [count]` | Staff, debug only | Completes `count` tasks of your own job in progress, or all of them if omitted. Does nothing unless debug is on.           |

{% hint style="info" %}
`<crew>` is required and `[count]` is optional. Every name can be changed in `commands` of `shared/config.lua`; set `name = false` to disable a command.
{% endhint %}

## Staff permissions

The staff commands are restricted to the group set in `commands.<id>.restricted`, `group.admin` by default. A player needs to belong to that group:

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

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

{% endcode %}

To use another group, change the value in the config:

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

```lua
commands = {
    reset = { name = 'gardreset' },
    leave = { name = 'gardleave' },
    list = { name = 'gardlist', restricted = 'group.mod' },
    close = { name = 'gardclose', restricted = 'group.admin' },
    fast = { name = 'gardfast', restricted = 'group.admin' },
},
```

{% endcode %}

{% hint style="warning" %}
`/gardfast` checks debug when the resource starts. Turn on `debug` in the config, or set `setr cuxial_gardener_debug 1` above the `ensure` line, and restart the resource.
{% endhint %}

## Who can do the job

The `job` option of the config decides it: `'all'` for everyone, or a list of framework jobs. It is checked when the panel opens, when a player is invited and when the job starts. Each region also asks for a minimum level from every crew member.

## Keys

| Key                  | What it does                                                                                                     |
| -------------------- | ---------------------------------------------------------------------------------------------------------------- |
| <kbd>E</kbd>         | Deliver the trucks, hitch or unhitch the lawn mower from the seat, plant a flower, close the end-of-job summary. |
| <kbd>H</kbd>         | Cancel flower placement.                                                                                         |
| <kbd>G</kbd>         | Climb down the ladder.                                                                                           |
| <kbd>Y</kbd>         | Accept a crew invitation.                                                                                        |
| <kbd>N</kbd>         | Decline a crew invitation.                                                                                       |
| <kbd>Backspace</kbd> | Hide the tip on screen.                                                                                          |

These are the defaults of `keys` in `shared/config.lua`. Each player can rebind them in the game settings, under key bindings.

{% hint style="info" %}
Changing `keys` only affects players who have never joined with the job installed. The game remembers the binding of everyone else.
{% 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/jobs/cuxial-gardener/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.