> For the complete documentation index, see [llms.txt](https://hacking-notes.jord4n.pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hacking-notes.jord4n.pro/es/useful-resources/gh0stzk-bspwm-dotfiles.md).

# Configuración de hacker en Arch Linux con BSPWM

Guía de configuración de hacker en Arch Linux con dotfiles gh0stzk BSPWM, instalación rápida, temas, Polybar, Rofi, ZSH, Neovim, comandos y atajos de teclado.

[gh0stzk/dotfiles](https://github.com/gh0stzk/dotfiles) es un entorno de escritorio BSPWM completo para Arch Linux y distribuciones basadas en Arch. Incluye temas, barras, lanzadores, ajustes de terminal, ZSH, Neovim, applets de Rofi, fondos de pantalla y scripts de ayuda para cambiar estilos rápidamente.

<figure><img src="https://user-images.githubusercontent.com/67278339/221605474-21d65156-0cf7-485c-bd1a-40792c37817e.png" alt="gh0stzk BSPWM dotfiles desktop screenshot with terminal and Linux fetch output"><figcaption><p>Ejemplo de entorno de escritorio BSPWM del README del proyecto.</p></figcaption></figure>

{% hint style="warning" %}
Instala esto solo en una máquina de laboratorio personal o en una estación de trabajo Linux nueva. Los dotfiles reemplazan muchos archivos de configuración del usuario, así que revisa el instalador y haz una copia de seguridad de tu configuración actual antes de ejecutarlo.
{% endhint %}

## Dónde encaja

Esto pertenece en `Recursos útiles` porque es un recurso de configuración de estación de trabajo, no una herramienta de pentesting. Úsalo cuando quieras un entorno BSPWM limpio basado en Arch para notas diarias, laboratorios, trabajo de CTF, desarrollo y flujos de trabajo centrados en la terminal.

## Qué te aporta

| Componente              | Lo que significa                                                                                               |
| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
| BSPWM                   | Gestor de ventanas en mosaico para un escritorio rápido impulsado por teclado.                                 |
| 18 temas                | Estilos visuales listos para usar que se pueden cambiar sobre la marcha.                                       |
| Polybar                 | Barra de escritorio con espacios de trabajo, módulos, información del sistema y colores del tema.              |
| Applets de Rofi         | Menús para apps, energía, capturas, portapapeles, red, Bluetooth, fondos de pantalla y más.                    |
| Terminales              | Compatibilidad con temas para Alacritty, Kitty, Ghostty, ST y Xfce Terminal.                                   |
| Configuración de ZSH    | Configuración de shell rápida con autocompletado, búsqueda en el historial y vistas previas de fzf-tab.        |
| Configuración de Neovim | Configuración preconstruida del editor con LSP, autocompletado, formateo, explorador, barra de estado y panel. |
| RiceEditor              | App de ayuda para ajustar la configuración visual sin editar manualmente cada archivo de configuración.        |

## Vista previa visual

El proyecto es muy visual, así que revisa las capturas y la demo antes de instalarlo.

<figure><img src="https://github.com/gh0stzk/dotfiles/assets/67278339/b11b5c58-b9ec-446b-8980-4f77bebb3432" alt="gh0stzk dotfiles theme selector screenshot"><figcaption><p>Selector de temas.</p></figcaption></figure>

<figure><img src="https://github.com/user-attachments/assets/dbac8c47-f12c-4242-97d6-38ad1193f76b" alt="gh0stzk dotfiles wallpaper selector screenshot"><figcaption><p>Selector de fondo de pantalla.</p></figcaption></figure>

<figure><img src="https://github.com/user-attachments/assets/2ac910c8-171f-47eb-8210-1469b6f75cc2" alt="gh0stzk dotfiles RiceEditor screenshot"><figcaption><p>RiceEditor para personalizar temas.</p></figcaption></figure>

### Demo del proyecto

{% embed url="<https://github.com/user-attachments/assets/3eaae1e2-04dc-4a9b-8c91-139f85f5fb9e>" %}

### Tutorial de instalación de Arch

Este video del creador es útil si quieres una instalación limpia de Arch antes de aplicar los dotfiles.

{% embed url="<https://www.youtube.com/watch?v=mspY7Mpmcug>" %}

### Canal del proyecto

El canal del autor contiene más demos de BSPWM, Polybar, Eww, Rofi y temas.

{% embed url="<https://www.youtube.com/@gh0stzk-dotfiles>" %}

## Antes de instalar

El instalador oficial está pensado para Arch Linux y distribuciones basadas en Arch. El README indica que las distribuciones que no usan systemd, como Artix, no son compatibles.

Punto de partida recomendado:

| Requisito                    | Notas                                                             |
| ---------------------------- | ----------------------------------------------------------------- |
| Distro Arch o basada en Arch | Una instalación nueva es lo más seguro.                           |
| Cuenta de usuario normal     | No ejecutes el instalador como root.                              |
| Internet funcional           | El instalador descarga paquetes y repositorios.                   |
| Gestor de inicio de sesión   | El proyecto recomienda LightDM.                                   |
| NetworkManager               | Necesario para el applet de red de Rofi.                          |
| Copia de seguridad           | Conserva una copia de los `~/.config` y los archivos de la shell. |

Comando útil de copia de seguridad antes de probar:

```bash
mkdir -p "$HOME/dotfiles-backup"
cp -a "$HOME/.config" "$HOME/dotfiles-backup/config-$(date +%F)" 2>/dev/null
cp -a "$HOME/.zshrc" "$HOME/.gtkrc-2.0" "$HOME/.icons" "$HOME/dotfiles-backup/" 2>/dev/null
```

## Configuración rápida de Arch

Usa esto cuando partas de una máquina o VM Arch limpia y quieras la ruta práctica más corta.

### 1. Arranca la ISO de Arch

Empieza con la ISO oficial de Arch. Si usas Wi-Fi, conéctate primero:

```bash
iwctl
```

Dentro de `iwctl`:

```
device list
station wlan0 scan
station wlan0 get-networks
station wlan0 connect "SSID"
exit
```

Comprueba la conexión a internet:

```bash
ping -c 3 archlinux.org
```

Sincroniza la hora:

```bash
timedatectl set-ntp true
```

### 2. Instala Arch rápidamente

La ruta rápida es `archinstall`:

```bash
archinstall
```

Opciones recomendadas:

| Opción                 | Elige                                                                        |
| ---------------------- | ---------------------------------------------------------------------------- |
| Distribución del disco | Predeterminada o manual, según tu VM/disco.                                  |
| Cargador de arranque   | `systemd-boot` para UEFI; GRUB si lo prefieres.                              |
| Perfil                 | La opción mínima es suficiente; el escritorio es opcional.                   |
| pestaña                | NetworkManager.                                                              |
| Audio                  | PipeWire.                                                                    |
| Usuario                | Crea un usuario normal con acceso a sudo.                                    |
| Paquetes adicionales   | `git curl base-devel xorg-server lightdm lightdm-gtk-greeter networkmanager` |

Después de la instalación:

```bash
reinicia
```

### 3. Activa lo básico

Inicia sesión como tu usuario normal y luego asegúrate de que los servicios base estén listos:

```bash
sudo pacman -Syu
sudo pacman -S --needed git curl base-devel xorg-server lightdm lightdm-gtk-greeter networkmanager
sudo systemctl enable --now NetworkManager
sudo systemctl enable lightdm
```

Reinicia una vez más si acabas de activar LightDM:

```bash
sudo reboot
```

## Instalación de los dotfiles

Abre una terminal desde tu directorio personal:

```bash
cd "$HOME"
```

Descarga el instalador oficial:

```bash
curl -LO http://gh0stzk.github.io/dotfiles/RiceInstaller
```

Revisa el instalador antes de ejecutarlo:

```bash
less RiceInstaller
```

Dale permiso de ejecución:

```bash
chmod +x RiceInstaller
```

Ejecuta esto como tu usuario normal:

```bash
./RiceInstaller
```

El instalador es interactivo. Puede preguntar si quieres las configuraciones incluidas de Neovim y Firefox. Lee cada aviso en lugar de pulsar Enter en todo.

### Instalación en un solo bloque

Para una instalación rápida de laboratorio después de tener Arch funcionando:

```bash
cd "$HOME"
curl -LO http://gh0stzk.github.io/dotfiles/RiceInstaller
less RiceInstaller
chmod +x RiceInstaller
./RiceInstaller
```

## Qué hace el instalador

A alto nivel, el instalador:

1. Comprueba que no se esté ejecutando como root.
2. Comprueba que se esté ejecutando desde `$HOME`.
3. Añade el `gh0stzk-dotfiles` repositorio de paquetes.
4. Añade Chaotic-AUR.
5. Descarga los dotfiles.
6. Hace copia de seguridad de las configuraciones existentes del usuario cuando es necesario.
7. Instala el entorno BSPWM.
8. Activa MPD para las funciones de música.
9. Cambia la shell a ZSH.

El script también mueve muchas carpetas de configuración existentes a un directorio de respaldo antes de reemplazarlas. Aun así, conserva primero tu propia copia de seguridad.

## Primer inicio de sesión

Después de la instalación:

1. Reinicia o cierra sesión.
2. Selecciona la sesión BSPWM en tu gestor de inicio de sesión.
3. Inicia sesión normalmente.
4. Espera a que el primer inicio termine la autoconfiguración.
5. Prueba la terminal, Rofi, Polybar, el selector de temas y el selector de fondos de pantalla.

Si estás en una máquina virtual y el escritorio se siente roto o lento, prueba a cambiar Picom de `glx` a `xrender` antes de asumir que la instalación falló.

## Primeras cosas que revisar

Después del primer inicio, verifica las variables relacionadas con el hardware. Abre:

```bash
~/.config/bspwm/config/system.ini
```

Comprueba los valores de:

| Valor               | Por qué importa                           |
| ------------------- | ----------------------------------------- |
| Interfaz de red     | Módulos de red en la barra.               |
| Tarjeta gráfica     | Algunos módulos visuales y de estado.     |
| Batería y adaptador | Módulos de batería y brillo del portátil. |

Si estás en un PC de escritorio, la interfaz de red suele ser la principal que debes revisar.

## Comandos útiles

| Comando                             | Use                                                                   |
| ----------------------------------- | --------------------------------------------------------------------- |
| `RiceSelector`                      | Abre el selector de temas.                                            |
| `RiceEditor`                        | Edita visualmente el tema actual.                                     |
| `WallSelect`                        | Abre el selector de fondos de pantalla.                               |
| `Term --selecterm`                  | Elige la aplicación de terminal.                                      |
| `OpenApps --menu`                   | Abre el lanzador de aplicaciones.                                     |
| `OpenApps --KeyHelp`                | Abre la chuleta de atajos de teclado.                                 |
| `OpenApps --screenshot`             | Abre la herramienta de capturas.                                      |
| `OpenApps --netmanager`             | Abre el applet del gestor de red.                                     |
| `OpenApps --bluetooth`              | Abre el applet de Bluetooth.                                          |
| `OpenApps --clipboard`              | Abre el gestor del portapapeles.                                      |
| `OpenApps --powermenu`              | Abre el menú de energía.                                              |
| `OpenApps --keyboard`               | Abre el applet de distribución del teclado.                           |
| `OpenApps --scratch`                | Abre el scratchpad.                                                   |
| `HideBar -h`                        | Oculta las barras.                                                    |
| `HideBar -u`                        | Muestra las barras.                                                   |
| `SoftReload`                        | Recarga suavemente el entorno.                                        |
| `ScreenLocker`                      | Bloquea la pantalla.                                                  |
| `bspc wm -r`                        | Recarga BSPWM.                                                        |
| `pkill -USR1 -x sxhkd`              | Recarga las combinaciones de teclas.                                  |
| `~/.config/bspwm/config/system.ini` | Variables de hardware/módulo que verificar después de la instalación. |
| `~/.config/bspwm/config/sxhkdrc`    | Archivo principal de atajos de teclado.                               |

## Combinaciones de teclas completas

El proyecto muestra la chuleta visual con `Alt + F1`. `Super` significa la tecla Windows en la mayoría de los teclados. La fuente de verdad es el `~/.config/bspwm/config/sxhkdrc`instalado; esta tabla sigue el archivo actual de upstream y agrupa todos los atajos para que sea más fácil de leer.

### Ayuda

| Teclas     | Acción                                   |
| ---------- | ---------------------------------------- |
| `Alt + F1` | Muestra la chuleta de atajos de teclado. |

### Aplicaciones principales

| Teclas                 | Acción                                 |
| ---------------------- | -------------------------------------- |
| `Super + Return`       | Abre la terminal normal.               |
| `Super + Alt + Return` | Abre la terminal flotante.             |
| `Super + Space`        | Abre el lanzador de aplicaciones.      |
| `Alt + Space`          | Abre el selector de temas.             |
| `Super + B`            | Abre el navegador.                     |
| `Super + E`            | Abre el editor.                        |
| `Super + F`            | Abre el gestor de archivos.            |
| `Super + Y`            | Abre Yazi.                             |
| `Super + V`            | Abre Neovim.                           |
| `Super + M`            | Abre el reproductor de música/Ncmpcpp. |
| `Super + P`            | Abre Pavucontrol.                      |
| `Super + T`            | Abre Telegram.                         |
| `Super + W`            | Abre WhatsApp.                         |
| `Super + R`            | Abre RiceEditor.                       |

### Applets de Rofi

| Teclas                          | Acción                                   |
| ------------------------------- | ---------------------------------------- |
| `Super + Alt + T`               | Selector de terminal.                    |
| `Super + Alt + W`               | Selector de fondo de pantalla.           |
| `Super + Alt + A`               | Applet de montaje de Android.            |
| `Super + Alt + N`               | Gestor de red.                           |
| `Super + Alt + B`               | Gestor de Bluetooth.                     |
| `Super + Alt + C`               | Gestor del portapapeles.                 |
| `Super + Alt + S`               | Herramienta de capturas.                 |
| `Super + Alt + P`               | Menú de energía.                         |
| `Super + Alt + L`               | Selector de estilo del lanzador de Rofi. |
| `Super + Alt + K`               | Applet de distribución del teclado.      |
| `Super + Alt + X`               | Applet de RofiPass/contraseñas.          |
| `Clic derecho en el escritorio` | Abre Jgmenu.                             |

### Sistema y entorno

| Teclas                   | Acción                                              |
| ------------------------ | --------------------------------------------------- |
| `Super + Alt + O`        | Scratchpad.                                         |
| `Ctrl + Super + Alt + P` | Apaga el ordenador.                                 |
| `Ctrl + Super + Alt + R` | Reinicia el ordenador.                              |
| `Ctrl + Super + Alt + Q` | Cierra sesión.                                      |
| `Ctrl + Super + Alt + L` | Bloquea la pantalla.                                |
| `Ctrl + Super + Alt + K` | Mata la aplicación con `xkill`.                     |
| `Ctrl + Super + Alt + S` | Recarga suave.                                      |
| `Super + Alt + H`        | Oculta la barra.                                    |
| `Super + Alt + U`        | Muestra la barra.                                   |
| `Ctrl + Alt + Plus`      | Aumenta la transparencia en la ventana enfocada.    |
| `Ctrl + Alt + Minus`     | Disminuye la transparencia en la ventana enfocada.  |
| `Ctrl + Alt + T`         | Restablece la transparencia en la ventana enfocada. |
| `XF86MonBrightnessUp`    | Aumenta el brillo.                                  |
| `XF86MonBrightnessDown`  | Disminuye el brillo.                                |
| `XF86AudioRaiseVolume`   | Aumenta el volumen.                                 |
| `XF86AudioLowerVolume`   | Disminuye el volumen.                               |
| `XF86AudioMute`          | Alterna el silencio.                                |
| `XF86AudioNext`          | Pista de audio siguiente.                           |
| `XF86AudioPrev`          | Pista de audio anterior.                            |
| `XF86AudioPlay`          | Reproduce/pausa el audio.                           |
| `XF86AudioStop`          | Detener el media.                                   |

### BSPWM Core

| Teclas              | Acción                                   |
| ------------------- | ---------------------------------------- |
| `Super + Alt + R`   | Recarga BSPWM.                           |
| `Super + X`         | Cerrar el nodo enfocado.                 |
| `Super + Shift + X` | Matar el nodo enfocado.                  |
| `Super + Escape`    | Recargar los enlaces de teclas de sxhkd. |

### Estados y banderas del nodo

| Teclas            | Acción                                        |
| ----------------- | --------------------------------------------- |
| `Alt + T`         | Establecer el nodo en mosaico.                |
| `Alt + Shift + T` | Establecer el nodo en mosaico pseudo.         |
| `Alt + A`         | Establecer el nodo flotante.                  |
| `Alt + F`         | Establecer el nodo en pantalla completa.      |
| `Alt + M`         | Alternar la bandera de marcado.               |
| `Alt + X`         | Alternar la bandera de bloqueado.             |
| `Alt + S`         | Alternar la bandera de pegajoso.              |
| `Alt + P`         | Alternar la bandera de privado.               |
| `Alt + H`         | Ocultar la ventana enfocada.                  |
| `Ctrl + Alt + H`  | Mostrar menú para restaurar ventanas ocultas. |

### Espacios de trabajo y enfoque

| Teclas                                  | Acción                                                                 |
| --------------------------------------- | ---------------------------------------------------------------------- |
| `Ctrl + Tab`                            | Rotar el escritorio.                                                   |
| `Super + Left`                          | Cambiar al espacio de trabajo anterior.                                |
| `Super + Right`                         | Cambiar al siguiente espacio de trabajo.                               |
| `Super + 1` a `Super + 9`               | Enfocar el espacio de trabajo 1 al 9.                                  |
| `Super + 0`                             | Enfocar el espacio de trabajo 10.                                      |
| `Super + Ctrl + 1` a `Super + Ctrl + 9` | Enviar la ventana enfocada al espacio de trabajo 1 al 9.               |
| `Super + Ctrl + 0`                      | Enviar la ventana enfocada al espacio de trabajo 10.                   |
| `Super + Ctrl + Left`                   | Enviar la ventana enfocada al espacio de trabajo anterior y seguirla.  |
| `Super + Ctrl + Right`                  | Enviar la ventana enfocada al siguiente espacio de trabajo y seguirla. |
| `Alt + Tab`                             | Selector de ventanas.                                                  |
| `Super + Alt + Left`                    | Enfocar la ventana al oeste, retroceder al anterior.                   |
| `Super + Alt + Down`                    | Enfocar la ventana al sur.                                             |
| `Super + Alt + Up`                      | Enfocar la ventana al norte.                                           |
| `Super + Alt + Right`                   | Enfocar la ventana al este, avanzar al siguiente.                      |
| `Ctrl + Alt + Left`                     | Intercambiar la ventana enfocada al oeste.                             |
| `Ctrl + Alt + Down`                     | Intercambiar la ventana enfocada al sur.                               |
| `Ctrl + Alt + Up`                       | Intercambiar la ventana enfocada al norte.                             |
| `Ctrl + Alt + Right`                    | Intercambiar la ventana enfocada al este.                              |
| `Ctrl + Shift + Comma`                  | Enfocar el último nodo.                                                |
| `Ctrl + Shift + Period`                 | Enfocar el último escritorio.                                          |

### Preselección

| Teclas             | Acción                                   |
| ------------------ | ---------------------------------------- |
| `Super + Ctrl + H` | Preseleccionar división horizontal/este. |
| `Super + Ctrl + V` | Preseleccionar división vertical/sur.    |
| `Super + Ctrl + Q` | Cancelar la preselección.                |

### Mover y redimensionar

| Teclas                  | Acción                                    |
| ----------------------- | ----------------------------------------- |
| `Super + Ctrl + B`      | Equilibrar los nodos del escritorio.      |
| `Super + Alt + Plus`    | Aumentar el tamaño del nodo en mosaico.   |
| `Super + Alt + Minus`   | Disminuir el tamaño del nodo en mosaico.  |
| `Super + Ctrl + Plus`   | Aumentar el tamaño del nodo flotante.     |
| `Super + Ctrl + Minus`  | Disminuir el tamaño del nodo flotante.    |
| `Super + Shift + Left`  | Mover la ventana flotante a la izquierda. |
| `Super + Shift + Down`  | Mover la ventana flotante hacia abajo.    |
| `Super + Shift + Up`    | Mover la ventana flotante hacia arriba.   |
| `Super + Shift + Right` | Mover la ventana flotante a la derecha.   |

### Operación múltiple

| Teclas                       | Acción                                                           |
| ---------------------------- | ---------------------------------------------------------------- |
| `Super + Ctrl + X`           | Cerrar todos los nodos en el escritorio actual.                  |
| `Super + N`, luego `X`       | Cerrar todas las ventanas locales no enfocadas.                  |
| `Super + N`, luego `K`       | Matar todas las ventanas locales no enfocadas.                   |
| `Super + N`, luego `M`       | Traer todas las ventanas marcadas al escritorio enfocado.        |
| `Super + N`, luego `1` a `9` | Traer todas las ventanas de ese escritorio al escritorio actual. |

## Personalización común

### Cambiar tema

Usa:

```
Alt + Space
```

Elige un tema del selector. El entorno se actualiza sin necesidad de reiniciar la sesión completa.

### Cambiar fondo de pantalla

Usa:

```
Super + Alt + W
```

El proyecto admite fondos de pantalla aleatorios, directorios personalizados, fondos fijos, fondos animados y comportamiento de presentación de diapositivas.

### Editar el tema actual

Usa RiceEditor cuando quieras ajustar la configuración visual sin editar manualmente cada módulo:

```
RiceEditor
```

Las ediciones típicas incluyen bordes, sombras, animaciones, transparencia, comportamiento del fondo de pantalla y configuraciones de módulos específicas del tema.

## Resolución de problemas

| Problema                                         | Qué comprobar                                                                                       |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
| El inicio de sesión vuelve al gestor de pantalla | Confirma que la sesión BSPWM esté instalada y revisa `~/.xsession-errors`.                          |
| Los módulos de la barra están incorrectos        | Comprueba `~/.config/bspwm/config/system.ini`.                                                      |
| El applet de red no funciona                     | Confirma que NetworkManager esté instalado y en ejecución.                                          |
| Los gráficos de la VM se ven dañados             | Prueba Picom `xrender` backend en lugar de `glx`.                                                   |
| Los atajos de teclado fallan                     | Comprueba `sxhkd` está en ejecución y revisa `~/.config/bspwm/config/sxhkdrc`.                      |
| El tema se ve desalineado                        | El proyecto está diseñado para 1600x900 y 96 DPI; ajústalo según tu monitor.                        |
| Las configuraciones existentes desaparecieron    | Comprueba la carpeta de copias de seguridad creada por el instalador y tu propio `dotfiles-backup`. |

## Notas de reinstalación limpia

Para la reintento más seguro:

1. Haz una copia de seguridad de tus archivos actuales.
2. Elimina o mueve los directorios antiguos de dotfiles.
3. Vuelve a descargar el último `RiceInstaller`.
4. Revisa el script otra vez.
5. Ejecútalo desde `$HOME` como usuario normal.

No ejecutes instaladores modificados al azar de bifurcaciones de terceros a menos que hayas revisado el diff.

## Referencias

* [repositorio oficial de gh0stzk/dotfiles](https://github.com/gh0stzk/dotfiles)
* [RiceInstaller](https://github.com/gh0stzk/dotfiles/blob/master/RiceInstaller)
* [Primeros pasos después de la instalación](https://github.com/gh0stzk/dotfiles/wiki/First-steps-after-installation)
* [wiki de atajos de teclado](https://github.com/gh0stzk/dotfiles/wiki/Keyboard-Shortcuts)
* [archivo actual de enlaces de teclas sxhkdrc](https://github.com/gh0stzk/dotfiles/blob/master/config/bspwm/config/sxhkdrc)
* [wiki de configuración de fondos de pantalla](https://github.com/gh0stzk/dotfiles/wiki/Wallpapers-Configuration)
* [ArchWiki: bspwm](https://wiki.archlinux.org/title/Bspwm)


---

# 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://hacking-notes.jord4n.pro/es/useful-resources/gh0stzk-bspwm-dotfiles.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.
