Empezar

Instalación desde cero

Esta página asume que no has instalado nada de Teacher. Está pensada para cualquier docente que prepare clase con su temario. Sirve en macOS y Linux. Windows todavía no está certificado.

Qué necesitas

macOS Terminal (o iTerm). Preferible con Homebrew, pero no obligatorio si usas nvm.
Linux Distribución reciente (Ubuntu, Debian, Fedora…). Terminal con bash o zsh.
Tiempo y disco Unos 15–30 min la primera vez. Reserva unos 3 GB libres (dependencias y modelos locales).
Clave de un LLM Por ejemplo NaN (NAN_API_KEY), Claude, OpenAI o Gemini. Sin clave puedes indexar; no generar materiales con modelo.
RAM Recomendado 8 GB. En máquinas justas cierra el navegador durante la primera vectorización.

Paso 1 — Instalar Node.js 22

Teacher solo soporta Node.js 22.x. La forma más simple para cualquiera es nvm (gestor de versiones de Node).

Instala nvm y luego Node 22:

Instalar nvm y Node 22
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
# Cierra y abre la terminal, o ejecuta:
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
nvm install 22
nvm use 22
node -v   # debe mostrar v22.x.x
npm -v

Paso 2 — Bajar el repositorio

Teacher se instala desde el repositorio público github.com/686f6c61/teacher (rama main). Cualquiera puede clonarlo. Sin esa descarga no hay binario teacher.

Repositorio público Código y actualizaciones en github.com/686f6c61/teacher. Cualquiera puede clonar e instalar.

Opción recomendada — clonar y luego instalar

Clonas el repo en tu máquina y ejecutas el instalador desde esa carpeta. Es la forma más clara de revisar el código y de actualizar con git pull.

Clonar el repositorio
git clone https://github.com/686f6c61/teacher.git
cd teacher
git checkout main
git pull --ff-only
Instalar desde la copia local
bash install-from-github.sh --yes
# Si usas Pi como entorno de agente:
# bash install-local.sh

Repositorio público: https://github.com/686f6c61/teacher. SSH: git clone git@github.com:686f6c61/teacher.git

Paso 3 — Instalar Teacher (un solo comando)

Si prefieres no clonar a mano: un comando descarga el instalador oficial, prepara el binario teacher y, si hace falta, registra el paquete en Pi.

Instalador remoto

install-from-github.sh vía curl
curl -fsSL https://raw.githubusercontent.com/686f6c61/teacher/main/install-from-github.sh | bash -s -- --yes

--yes evita preguntas interactivas. Puede tardar varios minutos (compila binarios nativos).

Descarga un script y lo ejecuta en tu máquina. Si ya clonaste en el paso 2, usa bash install-from-github.sh --yes dentro del repo y sáltate este curl.

Por defecto el instalador deja el código en ~/.local/share/teacher-cli (carpeta local en tu disco) y el comando en ~/.local/bin/teacher. El repositorio en GitHub es 686f6c61/teacher.

Paso 4 — Que la terminal encuentre teacher

Si al escribir teacher dice «command not found», el PATH no incluye ~/.local/bin. Abre una terminal nueva o ejecuta:

Activar PATH en esta sesión
export PATH="$HOME/.local/bin:$PATH"
export PATH="$HOME/.npm-global/bin:$PATH"
teacher --version
# Esperado: algo con 0.6.0

Para que sea permanente, añade esas líneas de export PATH=... al final de ~/.zshrc (macOS por defecto) o ~/.bashrc (muchas Linux), guarda, y abre una terminal nueva.

Comprobación rápida
teacher doctor
teacher status

doctor valida SQLite nativo y el proveedor. Avisos de LibreOffice o «no TTY» son normales en algunos entornos.

Paso 5 — Proveedor y clave de API

Sin un proveedor de lenguaje no hay generación con modelo. Elige el que ya uses. Ejemplo con NaN (un solo proveedor, simple):

Setup no interactivo (NaN)
export NAN_API_KEY="pega_aquí_tu_clave"
teacher setup --proveedor nan --modelo qwen3.6

Otras opciones habituales: anthropic, openai, google, ollama-cloud. Detalle de variables en Tu configuración.

Importante Nunca pegues la clave en course.config.yml ni en un chat público. Vive en la variable de entorno o en ~/.config/teacher-cli/credentials.env (permisos 600).

Paso 6 — Primera asignatura y un material

Crea una carpeta de trabajo, registra la asignatura, mete el temario y genera un material de prueba.

Carpeta y onboard

Asignatura
mkdir -p ~/cursos/mi-asignatura && cd ~/cursos/mi-asignatura
teacher onboard \
  --asignatura-id curso-101 \
  --asignatura-nombre "Mi asignatura"

Ingest y reindex

Sustituye la ruta por tu carpeta de PDFs.

Temario
teacher ingest --origen ~/Temario --asignatura-id curso-101
teacher reindex --asignatura-id curso-101
teacher status --asignatura-id curso-101

Un material de prueba

Cierre de clase
teacher ticket-salida "Tema 1" \
  --asignatura-id curso-101 \
  --output-dir out \
  --require-llm \
  --html

Abre el .html de out/ en el navegador. El comando del CLI se llama ticket-salida (cierre de clase en el catálogo). Siguiente: Cómo funciona, Materiales y comandos directos.

Otras formas de instalar

Si ya tienes un entorno, puedes saltarte el instalador completo:

Dentro de Pi

Si usas Pi como entorno de agente:

Paquete Pi
pi install npm:@uni-686f6c61/teacher
# Reinicia Pi o:
/reload
/teacher
/teacher:setup

Solo el binario global con npm

npm global
npm install -g @uni-686f6c61/teacher
teacher --version
teacher

Requiere Node 22 en el PATH. Mismo motor que el instalador de GitHub.

Si algo falla