rekhu

Getting started

Sites and keys

What a key is, which tools it lets Rekhu use on a site, staging and live sites, plugin updates, and how to disconnect.

One site, one key

A key connects one site or app to one project. The plugin or package sends it with every call, so the account knows which site is asking and meters the work per site. That is why your usage lists every site on its own line.

Never use a key on a second site. Make a project for that site and give it its own key.

A key is shown once, when it is made. Copy it straight into the plugin or the install command. If it is lost, make a new key on the project: the old one stops working at that moment.

Connect a WordPress site

  1. Make the key. Open the project, go to the Connection tab and press Make a key in the Rekhu Builder card. The key is shown once.
  2. Install the plugin. Press Download Rekhu Builder in the same card, then in WordPress go to Plugins → Add plugin → Upload, install and activate it.
  3. Paste the key. Open Rekhu Builder in the WordPress menu, paste the key and press Connect.
  4. Check the project. Go back to the project: the site shows as reachable and the chat can start.

The site needs to reach rekhu.com over HTTPS. If the project does not show the site as connected, open Rekhu Builder in WordPress once and press Check connection.

Connect a Laravel app

The project chat on a Laravel app runs on the rekhu/laravel-dev package. Make a key in the Rekhu Builder card of the Connection tab; it comes with the two commands to run in the app's folder:

composer require rekhu/laravel-dev
php artisan rekhu:install --key=…
php artisan rekhu:status

On a laptop, in Docker or behind a firewall, keep php artisan rekhu:listen running while you chat. Laravel 10.48 to 13 and PHP 8.2 or newer are supported.

Note: Rekhu Assistant, the assistant inside your app for its own users, has keys of its own, one per environment, in the Rekhu Assistant card. An assistant key does not connect the project chat. See Rekhu Assistant.

Connect an Odoo database

  1. Make the key in the Rekhu Builder card of the Connection tab.
  2. Install the module. Install Rekhu Builder (rekhu_builder) from the Odoo Apps store, or put the module in your addons path.
  3. Connect. In Odoo open Settings → Rekhu Builder, paste the key, choose what the database is (local, staging or production) and press Connect.

On a laptop, in Docker or behind a firewall, keep odoo rekhu_listen -d <database> running.

What a key may do

Every plugin or package tells the account which tools it has. Once a site is connected, the Connection tab lists them under Tools, each marked as reading or changing.

Switch tools off for one site

  1. Open the list. On the project's Connection tab, open Tools.
  2. Untick what Rekhu may not use. For example installing plugins on a client's production site.
  3. Save. Press Save the switches. The site follows within a minute.

A tool that is off stays off for that site, whatever the chat asks.

Limits for every site

Under Preferences you set limits that hold on every site of the account:

  • What it may do: a module that is off there is off on every site. Reading the site, templates, files and the chat are always on.
  • Safety: ask before changing a published page (on by default), ask before installing or activating a plugin, never change global styles, and a list of pages to leave alone.

Staging and live sites

A staging copy connects like any other site: make a project for it and give it its own key. Everything works the same there, so it is a good place to try a conversion or a new skill before you do it on the live site.

On a live site, Rekhu works on drafts where it can. A change to a page that visitors already see is asked first, saved beforehand and checked afterwards. See Changes to live pages.

On a Laravel app in production, Rekhu Builder only reads and reports; it changes nothing there.

Plugin updates

The plugin updates itself from the account. When you connect a site, Rekhu Builder puts itself on WordPress's own auto-update list, so a new release installs in the site's regular update run. You stay in control:

  • The Plugins screen shows Disable auto-updates for Rekhu Builder like for any plugin.
  • Under the plugin's Settings tab, Check for updates now asks the account at once.

Each release is listed in the news with what changed.

Replace or disconnect a site

You want to Do this
Replace a lost or leaked key New key on the Connection tab. The old key stops working at once; paste the new one in the plugin.
Point the project at another connected site Change site on the Connection tab and pick a free site.
Stop the site and remove the project Delete project on the Connection tab. Its chats, knowledge and history go, and every key of the project is blocked.
Block one Rekhu Assistant key Block next to that key in the Rekhu Assistant card.

Rekhu Builder runs only with a key from your account. Once its key is blocked, the plugin can no longer do anything on the site.

Next