START

Quick Start

Clone → install → run · mock o Telegram
heteronimos-semi-asistidos-sdk · grammY
v0.0.0 · pre-kick-off

☞ 1. Clone & Install

# instala Bun primero si no lo tienes → bun.sh git clone https://github.com/escrivivir-co/heteronimos-semi-asistidos-sdk.git cd heteronimos-semi-asistidos-sdk && bun install
# valida que todo compila y los tests pasan bun run lint && bun run test
Dos arquetipos de app: headless (consola, bot as a service) e interactive (dashboard TUI con panel admin)

☞ 2. Run

No necesitas configurar nada antes de arrancar. Si no hay .env, la app te guía.
# arranca en modo dev (watch) bun run dev

Console App

Directorio: examples/console-app/
Sin .env
La consola detecta que falta .env.
Si existe .env.example, te pregunta:

¿Crear .env a partir de .env.example? (y/n)

Si dices , copia la plantilla y te pregunta si quieres editarlo o continuar en modo mock.
Sin BOT_TOKEN
Si BOT_TOKEN no está configurado, te ofrece:

¿Arrancar en modo mock (sin Telegram)? (y/n)

→ arranca en modo mock (sin conexión real).
No → sale con código 1.
La consola es interactiva: siempre te pregunta antes de decidir.

Dashboard TUI

Directorio: examples/dashboard/
Sin .env
El dashboard arranca en modo non-interactive.
Si falta .env o BOT_TOKEN, entra automáticamente en modo mock — sin preguntar.
Config Panel
El panel de configuración muestra el estado:

● MOCK o ● TELEGRAM
BOT_TOKEN: configured / not set
.env: exists / missing

Si falta .env y existe .env.example, pulsa [c] para crearlo desde la plantilla.
El dashboard nunca bloquea: siempre arranca, luego configuras desde la UI.

☞ Obtener un Bot Token de Telegram

Bot nuevo: abre @BotFather en Telegram → envía /newbot → copia el token que devuelve.
Bot existente: abre /mybots → elige tu bot → sección API token → ver o regenerar → pega en BOT_TOKEN.
# .env (no subir a git) BOT_TOKEN=your-bot-token SOLANA_ADDRESS=your-address
Más info: tutorial oficial de Telegram

Comparativa

Console AppDashboard TUI
Prompts interactivos
Mock automático sin .env✘ (pregunta)
Config desde UI✔ (Config Panel)
Crear .env desde plantillaPrompt terminalPulsa [c] en UI
Sale si rechazas todo✘ (siempre mock)
Bun TypeScript grammY mock-mode .env BotFather console-app dashboard