> 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-electrician/installation.md).

# Installation

Install Cuxial Electrician step by step: dependencies, convars and start order.

Cuxial Electrician needs no SQL import and no inventory items. It creates its own tables on first start.

{% stepper %}
{% step %}

## Check the dependencies

These resources must be installed and working before you add the job:

* `ox_lib`
* `oxmysql`
* `cuxial_bridge`, with one of the supported frameworks: QBox, QBCore or ESX
* `sleepless_interact`
* OneSync enabled on the server

`cuxial_garages` is optional. When it is running, every crew member receives the keys of the service trucks at the start of the job and loses them at the end. Without it the script hands out no keys.
{% endstep %}

{% step %}

## Copy the resources

The package contains two folders. Place both inside your `resources` directory and keep their names:

* `cuxial_jobs`, the shared library of the Cuxial jobs
* `cuxial_electrician`

{% hint style="warning" %}
If you already own another Cuxial job, you already have `cuxial_jobs`. Keep a single copy, and use the newest one.
{% endhint %}
{% endstep %}

{% step %}

## Check the game build

The ladder used on street lamps is a game model added in build 2944. On an older build the job still works, with a shorter ladder.

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

```cfg
sv_enforceGameBuild 2944
```

{% endcode %}

Any build equal to or newer than 2944 is valid. Skip this step if your server already enforces one.
{% endstep %}

{% step %}

## Set the convars

All of them are optional.

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

```cfg
# Language of the job (en and es are included)
setr ox:locale "en"

# Discord webhook for job logs
set cuxial_electrician_webhook "https://discord.com/api/webhooks/..."

# Debug traces in the console
setr cuxial_electrician_debug "0"
```

{% endcode %}

{% hint style="info" %}
The webhook goes in `server.cfg`, never in `shared/config.lua`. The name of the convar can be changed in `logs.convar`.
{% endhint %}
{% endstep %}

{% step %}

## Start the resources

Start the job after its dependencies and after your framework. `cuxial_jobs` must start before the job:

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

```cfg
ensure ox_lib
ensure oxmysql
# your framework here (qbx_core, qb-core or es_extended)
ensure cuxial_bridge
ensure sleepless_interact
# optional
ensure cuxial_garages
ensure cuxial_jobs
ensure cuxial_electrician
```

{% endcode %}

No SQL to run. On start the job creates `cuxial_jobs_players`, `cuxial_jobs_runs`, `cuxial_jobs_run_members` and `cuxial_jobs_audit`. These tables are shared by all the Cuxial jobs.

{% hint style="info" %}
Do not import the file in the `install` folder. The job creates the tables it uses on start.
{% endhint %}
{% endstep %}

{% step %}

## Check that it works

1. Join the server and open the map. The job blip is at the position set in `npc.coords`.
2. Go to the NPC and use the interaction. The panel opens.
3. Pick a region and press **Start job**. A service truck appears at the spawn point of the region and the repair points show up on the map.
4. Repair every point, drive the truck back to the drop-off and press <kbd>E</kbd> at the wheel. The summary shows the payment.
   {% endstep %}
   {% endstepper %}

Next: adjust the job to your server in [Configuration](/scripts/jobs/cuxial-electrician/configuration.md).


---

# 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-electrician/installation.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.