AhmedOsman101/commit-sage-cli
AhmedOsman101/commit-sage-cli has 63 GitHub stars and 2 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-15 22:13 UTC. Last push 2026-11-06.
Crecimiento de estrellas medido
- in 24h
- 0
- in 7 days
- Actualización retrasada
- in 15 days
- Actualización retrasada
- in 1 month
- Actualización retrasada
Cambios netos en períodos que se solapan, no totales diarios. Los datos no disponibles se dejan en blanco. Las estrellas indican interés, no calidad.
Acerca de
Generates Conventional Commit messages with AI. Supports OpenAI, Ollama, and Gemini.
Herramientas de desarrollodocs/readme/README.es-ES.md
OriginalCommit Sage
Genera mensajes de commit significativos con IA — o análisis estático offline — directamente desde tu terminal.
Descripción
Commit Sage convierte tu git diff en un mensaje de commit. Dos caminos, una misma superficie:
- Camino IA — diff + contexto -> proveedor (OpenAI, Gemini, Ollama, … 11
en total) -> mensaje estructurado (
conventional/angular/emoji/semantic/freeform). - Camino offline —
git diff-index --name-status-> mensaje convencional determinista (port de auto-commit-msg, sin API, sin red). Ideal para CI o entornos sin clave.
Elige la superficie según el momento: generate imprime un mensaje a stdout
(canalizable, usable en hooks), commit ejecuta el flujo completo selección -> vista previa -> commit
-> push, config inspecciona o edita la configuración JSON.
Requisitos
- Git en tu
PATH. - Internet para proveedores IA (omítelo con
--offlineoollamalocal). - Bun 1.4.x solo si compilas desde el código fuente (
mask compile).
Instalación
Cuatro formas — todas instalan el mismo binario commit-sage.
Binario precompilado (Releases)
Descarga el artefacto para tu plataforma desde Releases.
# ejemplo: Linux x64 — elige el artefacto que coincida con `uname -s` / `uname -m`
curl -L -o commit-sage https://github.com/AhmedOsman101/commit-sage-cli/releases/latest/download/commit-sage-linux-x64
chmod +x commit-sage
mv commit-sage ~/.local/bin/commit-sage # asegúrate de que ~/.local/bin esté en $PATH
commit-sage --version
Activos producidos por mask release -> bin/:
commit-sage-linux-x64commit-sage-linux-arm64commit-sage-macos-x64commit-sage-macos-arm64commit-sage-windows-x64.execommit-sage-windows-arm64.exe
Los instaladores DMG de macOS y NSIS de Windows también se publican — ver abajo.
Instalación rápida (Linux y macOS)
curl -fsSL https://raw.githubusercontent.com/AhmedOsman101/commit-sage-cli/main/installer/unix.sh | bash
Esto ejecuta installer/unix.sh: detecta linux/macos +
x86_64/arm64, obtiene la última vX.Y.Z de la API de GitHub, instala
en ~/.local/bin/commit-sage (sobrescribe con INSTALL_DIR), opcionalmente
añade ~/.local/bin a tu config de shell y verifica con commit-sage --version.
Personaliza:
INSTALL_DIR=~/bin VERSION=1.8.0 bash <(curl -fsSL https://raw.githubusercontent.com/AhmedOsman101/commit-sage-cli/main/installer/unix.sh)
Ver installer/README.md para el curl manual + configuración de PATH.
AUR (Arch Linux)
paru -S commit-sage-bin
# yay -S commit-sage-bin
Instala el paquete commit-sage-bin,
que sigue las versiones de GitHub.
Windows
- Instalador (recomendado): descarga
commit-sage-setup.exedesde Releases y ejecuta el asistente. Instala enC:\Program Files\commitSage, añade aPATH, crea accesos de Menú Inicio + Escritorio. Construido coninstaller/windows/commit-sage.nsi; verinstaller/windows/build-installer.ps1. - Portable: descarga
commit-sage-windows-x64.exe, renombra acommit-sage.exe, colócalo donde quieras enPATH. - DMG macOS:
CommitSage-<version>-macos-{x64,arm64}.dmgvíainstaller/macos/build-dmg.sh(requierecreate-dmg).
Compilar desde el código fuente
git clone https://github.com/AhmedOsman101/commit-sage-cli.git commit-sage
cd commit-sage
mask compile # -> ~/.local/bin/commit-sage
mask release # cross-compila los 6 targets -> bin/
Uso
commit-sage sin argumentos imprime ayuda (convención git/npm) — nunca genera silenciosamente. Subcomandos:
commit-sage [flags]
generate Genera un mensaje desde el diff staged, lo imprime a stdout
commit Flujo interactivo: seleccionar archivos -> generar -> vista previa -> commit -> push opcional
config Inspeccionar o modificar la configuración (get/set/list/path/default/open/edit)
help [sub] Muestra ayuda para un subcomando
--help, -h Muestra ayuda
--version, -V Muestra versión (2.0.0)
Códigos de salida:
0éxito (incluido--pushwarn-and-skip cuando no hay remote).1error CLI/IO/config.2uso (flag desconocido / arg faltante).130abortado (Esc en el TUI, SIGINT).
commit-sage generate [flags]
Texto puro entrada/salida.
Flujo interactivo:
- Si nada staged -> TUI multiselect sobre unstaged tracked + untracked (Cliffy
Checkbox, buscable, select-all) ->
git add. - Re-verifica staged; si sigue vacío y
commit.onlyStagedChanges=true-> salida 1; si no, respetageneration.diffStrategy. - Genera mensaje (IA o
--offline). - Vista previa markdown vía
@littletof/charmd(subject en negrita + body).
Imprime el resultado. Sale sin hacer commit, útil para canalizar e integrar con otras herramientas.
[!Important] Necesita un TTY para el selector/confirmación. Ver Non-TTY abajo.
commit-sage commit [flags]
Mismo flujo interactivo que commit-sage generate más:
- Confirmación (
commit.autoCommito-y/--yesla omite). git commit -m "<subject>" -m "<body>"(-esi--edit).git pushopcional (ver--pushabajo;-uen el primer push, aviso-y-salto si no hayorigin).
commit-sage config <subcommand>
7 subcomandos, no requiere repo git:
| Subcomando | Qué hace |
|---|---|
get <section>.<key> |
Imprime un valor combinado; avisa not set — using default fallback: … si no está definido por el usuario |
set <section>.<key> <value> |
Convierte (boolean/number/string según TYPE_MAP) + validateOrError + persiste en CONFIG_PATH |
list / print |
Vuelca config combinada (defaults + sobrescrituras) como JSON |
path |
Imprime CONFIG_PATH |
default |
Imprime DEFAULT_CONFIG como JSON |
open |
Abre CONFIG_PATH en el handler del SO (open/xdg-open/cmd /c start), fallback a $EDITOR |
edit |
Abre en $EDITOR/$VISUAL/fallback (vi/notepad), re-lee, parsea JSON, validateOrError — inválido restaura backup en memoria |
Las claves son <section>.<key> con section siendo una sección válida de config.
Sección/clave desconocida o tipo erróneo -> salida 1 con mensaje claro.
Ejemplos
Todos asumen que estás dentro de un repo git y commit-sage está en tu $PATH.
# 1 — generación básica: diff staged -> mensaje IA a stdout (canalizable)
commit-sage generate
# 2 — offline (sin API, no necesita TTY): mensaje convencional determinista desde filas de estado
commit-sage generate --offline
# 3 — flujo interactivo de commit: elegir archivos -> vista previa -> confirmar -> git commit
commit-sage commit
# 4 — commit + push rama actual (aviso-y-salto si no hay origin, salida 0)
commit-sage commit --push
# 5 — cambiar modelo sin abrir un archivo (string único proveedor/modelo)
commit-sage config set model openai/gpt-5
# 6 — inspeccionar config combinada
commit-sage config print
# bonus — commit offline, y generación con contexto IA extra + longitud máxima personalizada
commit-sage commit --offline
commit-sage generate --context "fixes #123, retry on 5xx" --max-length 72
commit-sage generate --model ollama/gpt-oss-120b --format emoji --lang russian
commit-sage config get model
commit-sage config path
Referencia de flags
Flags compartidos generate / commit
Una tabla — ambos subcomandos aceptan los mismos 9 flags (commit añade 3 más abajo).
| Flag | Descripción | Notas |
|---|---|---|
--offline |
Usa generador de análisis estático (sin API). Siempre forma convencional <type>: <desc> o simple <desc>; trunca en límite de palabra --max-length. |
Ignora --format; sigue respetando --max-length; necesita filas git diff-index — archivos untracked no aparecerán hasta hacer stage. |
--context <text> |
Inyecta ## External Context\n<text> antes del diff en el prompt IA. |
Solo IA — ignorado con --offline. |
--model <name> |
Modelo para esta ejecución en formato proveedor/modelo (ej. openai/gpt-5.6-luna). La primera barra separa proveedor de modelo; ids multisegmento preservados (9router/kc/stealth/ox-alpha). |
Sobrescritura por ejecución del model top-level; cualquier string proveedor/modelo aceptado — el proveedor valida al llamar. |
--format <name> |
Plantilla de commit: conventional, angular, karma, emoji, semantic, freeform, emojiKarma, google, atom, detailed, previous. |
Solo IA — ignorado con --offline (offline siempre convencional). Default conventional (ver commit.commitFormat). previous imita tu historial reciente (cuerpos/footers incluidos). |
--lang <name> |
Idioma del commit (BCP-47, guardado tal cual, ej. en, en-US, jp). Cualquier otro valor es un idioma personalizado — ver Idiomas personalizados. |
Sobrescritura por ejecución de commit.commitLanguage; etiquetas nativas normalizadas internamente. Una etiqueta desconocida propone traducir una vez (salida 0 si se rechaza o sin TTY). |
--max-length <n> |
Sobrescribe commit.maxLength para este mensaje. |
Aplica a ambos IA y --offline (truncado en límite de palabra + …). |
--edit |
Abrir antes de guardar. | generate: tempfile + $EDITOR/$VISUAL -> imprime final a stdout. commit: pasa -e a git commit -> editor sobre el mensaje staged. |
--ref <token> |
Adjunta token(s) de ref explícitos para esta ejecución. Repetible: --ref PROJ-1 --ref PROJ-2 renderiza ambos. |
Solo IA — ignorado con --offline. Gana a --refs y a commit.refs.source; implica refs para la ejecución aunque commit.refs.enabled sea false. |
--refs |
Fuerza un único prompt interactivo de refs para esta ejecución, aunque commit.refs.source sea branch o input. |
Solo IA — ignorado con --offline. Solo TTY; sin TTY avisa y omite refs (salida 0). Implica refs para la ejecución aunque commit.refs.enabled sea false. |
Flags solo de commit:
| Flag | Aplica a | Descripción | Notas |
|---|---|---|---|
--push [branch] |
commit |
Push tras un commit exitoso. Bare --push empuja la rama actual; --push <name> empuja esa rama. |
Aviso-y-salto (no falla) si no hay remote / no hay origin; auto -u (set upstream) en el primer push a una rama. Salida 0 incluso al omitir. |
--no-push |
commit |
No hacer push, aunque commit.autoPush=true o --push fuese anterior. |
Sobrescribe --push y commit.autoPush. |
-y, --yes |
commit |
Omitir diálogos de confirmación (commit + confirmación de push) sin importar commit.autoCommit / commit.autoPush. |
También leído como commit.autoCommit/commit.autoPush en config. |
Subcomandos config
| Subcomando | Descripción |
|---|---|
get <section>.<key> |
Imprime un valor; avisa si la clave no está definida por el usuario y hace fallback a DEFAULT_CONFIG. |
set <section>.<key> <value> |
Convierte + valida + persiste (no necesita flag --write). Boolean: true/false (insensible a mayúsculas). Number: finito. String: crudo. |
list / print |
Config combinada como JSON (defaults + sobrescrituras del usuario). Alias: print. |
path |
CONFIG_PATH resuelto. |
default |
DEFAULT_CONFIG como JSON. |
open |
Handler del SO -> fallback $EDITOR. |
edit |
$EDITOR/$VISUAL/fallback (vi/notepad) + backup en memoria y restauración ante JSON inválido o fallo validateOrError; imprime Config saved and validated. al éxito. |
Non-TTY
generate-> requiere$PROVIDER_API_KEY(ej.OPENAI_API_KEY,GEMINI_API_KEY;ollamano necesita) cuando stdin no es un TTY. Si no, falla conNo API key found in $... and stdin is not a TTY.... Todos los prompts interactivos colgarían — por eso fallamos rápido.commit-> falla sin un TTY (selector de staging + confirmaciones son interactivos). Usar--offlinecon--yesaún necesita un TTY para el flujo; para CI, prefieregenerate --offline | git commit -F -.--offline(ambos subcomandos) -> siempre no-interactivo, sin clave, sin TTY.- Prompts de refs (
commit.refs.source: prompt, o--refs) sin TTY avisan y continúan sin refs — nunca un error, para no romper pipes.
Configuración
La config vive en ~/.config/commitSage/config.json en
Linux/macOS, %APPDATA%\commitSage\config.json en Windows (ver
src/lib/constants.ts:CONFIG_PATH), más un DEFAULT_CONFIG en proceso.
Inspecciona con commit-sage config list (combinada) o commit-sage config default (defaults).
Resuelve la ruta con commit-sage config path.
Define con commit-sage config set <section>.<key> <value> o edita con commit-sage config edit / commit-sage config open.
Cada set/edit valida contra config.schema.json (generado desde
src/lib/types/configSchema.ts — ejecuta mask schema build / mask schema check
— no edites el schema a mano).
model top-level + registro providers (Config V2)
Un único string canónico selecciona proveedor y modelo. División en la primera
/ — izquierda proveedor, derecha modelo (barras siguientes preservadas):
| Clave | Tipo | Por defecto | Descripción |
|---|---|---|---|
model |
string (forma a/b) |
"openai/gpt-5.6-luna" |
"9router/kc/stealth/ox-alpha" -> proveedor 9router, modelo kc/stealth/ox-alpha. Falla sin / |
El transporte por proveedor vive en el registro providers. providers.defaults
guarda defaults IA compartidos; providers.<name> sobrescribe por proveedor
(registro abierto — routers propios sin cambios de código):
| Clave | Tipo | Por defecto | Descripción |
|---|---|---|---|
providers.defaults.timeoutMs |
number |
60000 |
Timeout de la petición |
providers.defaults.reasoning |
string/boolean |
"off" |
off, default, low, medium, high, xhigh, ultra (tri-estado con boolean) |
providers.defaults.apiType |
string |
"openai-chat" |
openai-chat, openai-responses, anthropic |
providers.<name>.baseUrl |
string |
por proveedor | ej. http://localhost:11434/api para ollama |
providers.<name>.apiKey |
string |
"$<NAME>_API_KEY" |
Prefijo $ lee env, si no literal del archivo; opcional para locales (ollama) |
providers.<name>.apiType |
string |
hereda | Sobrescritura por proveedor |
providers.<name>.models |
mapa | — | Presets por modelo (name, reasoning, contextWindow, maxInputTokens, maxOutputTokens, temperature) |
Los presets providers.<name>.models resuelven por valor
(preset de modelo > proveedor > defaults) y se gestionan con config edit —
config get/set sigue shallow por diseño.
Internamente, los proveedores compatibles con OpenAI (deepseek, mistral,
moonshotai, xai, minimax, zai) comparten el cliente OpenAI — sus
paquetes SDK dedicados fueron eliminados. Solo anthropic, google, ollama,
openai y openrouter conservan paquetes dedicados. Los nombres de
proveedor, las claves de configuración y el comportamiento de las peticiones
no cambian.
No confundas el string model guardado con el flag por ejecución
--model (ver Referencia de flags).
Preset de Groq + gateways genéricos
groq es un preset listo para usar: groq/<modelo> con $GROQ_API_KEY y URL
base https://api.groq.com/openai/v1. El ejemplo canónico es
groq/openai/gpt-oss-120b (un id alojado en Groq, no nuestro);
groq/qwen/qwen3-8b-27b es la alternativa más ligera con los mismos límites
del nivel gratuito.
Cualquier otro endpoint compatible con OpenAI se puede usar por nombre — sin
esperar una release. Dale una entrada providers.<nombre> con baseUrl (más
apiType: openai-chat por defecto, openai-responses o anthropic) y usa
<nombre>/<modelo>:
"providers": {
"omniroute": {
"baseUrl": "https://gateway.example.com/v1",
"apiKey": "$OMNIROUTE_API_KEY",
"apiType": "openai-chat",
"headers": { "X-Custom-Auth": "abc" }
}
}
headers envía cabeceras extra (auth del gateway, atribución);
useApiKey: false no envía cabecera Authorization. Los hosts locales
(localhost, *.local, *.internal) sin clave tampoco la envían. Un
proveedor desconocido sin baseUrl es un error de configuración que nombra
providers.<nombre>.baseUrl.
Niveles de reasoning
reasoning acepta off, default, un tri-estado boolean, o un nivel
explícito. false/"off" desactiva; true/"default" significa default
del proveedor con reasoning activado (se omite temperature, sin forzar
nivel).
Subconjuntos honestos por proveedor (reflejados en el JSON schema; cualquier otro valor pasa tal cual — tú eres responsable de lo que la API haga con él):
| Proveedor(es) | Niveles |
|---|---|
openai, groq, zai |
none, minimal, low, medium, high, xhigh, max |
anthropic |
low, medium, high, xhigh, max |
gemini |
minimal, low, medium, high |
xai |
low, high (medium se mapea a high en silencio) |
ollama, openrouter, deepseek, mistral, moonshotai, minimax |
ignorado (no se envían opciones de reasoning) |
Los gateways desconocidos aceptan el set completo (none, xhigh, max,
ultra incluidos) como passthrough literal.
El thinking de Gemini depende de la familia: thinkingLevel
(minimal|low|medium|high, por defecto low) solo aplica a gemini-3*
(ahí el thinking no se puede desactivar); thinkingBudget (0 desactiva,
-1 decide el modelo, Pro mínimo 128) solo aplica a gemini-2.5*;
gemini-2.0/Gemma no envían ninguno. Los tokens de thinking salen de
maxOutputTokens, así que un budget grande puede dejar sin espacio al
mensaje — el reintento por truncado duplica el budget para compensar.
Todas las secciones de un vistazo
| Sección | Clave | Tipo | Por defecto | Notas |
|---|---|---|---|---|
generation |
maxRetries |
number |
3 |
Reintento en fallo de API |
generation |
retryDelay |
number |
1000 |
Backoff de reintento |
generation |
temperature |
number |
0.7 |
Temperatura del modelo (default global; presets por modelo pueden sobrescribir) |
generation |
maxPromptTokens |
number |
100000 |
Tokens de diff enviados a la IA (truncado contado por tokens) |
generation |
maxOutputTokens |
number |
4096 |
Presupuesto de salida por intento; overrides por proveedor/modelo ganan; se duplica en reintentos por truncado (techo 32768) |
generation |
diffStrategy |
string |
"auto" |
staged / unstaged / auto |
providers |
defaults.timeoutMs |
number |
60000 |
Timeout compartido |
providers |
defaults.reasoning |
string |
"off" |
Default compartido de reasoning |
providers |
defaults.apiType |
string |
"openai-chat" |
Tipo API compartido |
providers |
<name>.baseUrl |
string |
por proveedor | ej. ollama -> "http://localhost:11434/api"; openrouter -> "https://openrouter.ai/api/v1" |
providers |
<name>.apiKey |
string |
"$<NAME>_API_KEY" |
Prefijo $ lee env, si no literal; opcional para locales |
providers |
<name>.apiType |
string |
hereda | openai-chat, openai-responses, anthropic |
commit |
autoCommit |
boolean |
false |
Omite confirmación Commit changes? (o usa -y/--yes) |
commit |
autoPush |
boolean |
false |
Omite confirmación Push to <branch>? (o usa -y/--yes) |
commit |
commitFormat |
string |
"conventional" |
conventional, angular, karma, emoji, semantic, freeform (freeform solo IA), emojiKarma, google, atom, detailed, previous (estilo del historial) |
commit |
onlyStagedChanges |
boolean |
true |
Cuando es true y nada staged tras el selector, commit sale con No staged changes; si no, cae a diffStrategy |
commit |
commitLanguage |
string |
"english" |
BCP-47, guardado tal cual (en, en-US, jp …); --lang sobrescribe. Seis idiomas nativos (english, russian, chinese, japanese, german, french); cualquier otro valor es un idioma personalizado |
commit |
customInstructions |
string |
"" |
Guía permanente inyectada como ## Custom Instructions para cada formato. Termina en .md y el archivo existe -> se lee el archivo; si no texto literal. Vacío ⇒ sección omitida |
commit |
promptForRefs |
boolean |
false |
Obsoleto, reemplazado por commit.refs. Se conserva para que configs existentes validen; nunca se lee |
commit |
refs |
object |
{enabled:false,source:"prompt",value:"",placement:"end",branchPattern:"[A-Z][A-Z0-9]*-[0-9]+"} |
Footer de refs de issues/tickets — ver Issue refs; vía config edit, get/set superficial |
commit |
maxLength |
number |
80 |
Límite de subject; --max-length por ejecución |
commit |
bodyStyle |
string |
"subject-body" |
subject-only, subject-body, subject-body-footer |
commit |
recentCommits |
object |
{enabled:false,count:5,scope:"all"} |
Mensajes recientes como ejemplos de estilo (enabled, count 1–20, scope all/mine); vía config edit, get/set superficial |
git |
timeoutMs |
number |
30000 |
Timeout de subprocesos git (diff, status, blame, log); 0 desactiva; blame/log degradan a vacío con aviso, diff es error duro |
Las variables de entorno siguen siendo alternativa para la clave: define GEMINI_API_KEY,
OPENAI_API_KEY, etc. antes de ejecutar. Para una sola ejecución:
OPENAI_API_KEY='sk-...' commit-sage generate --model openai/gpt-5
Ollama no necesita clave. Las claves guardadas en el archivo JSON siguen el mismo enrutado proveedor/modelo.
Instrucciones personalizadas
commit.customInstructions es guía permanente aplicada a cada formato, inyectada como sección ## Custom Instructions en el prompt IA. Dos formas, detectadas automáticamente:
{
"commit": {
// texto literal, usado tal cual
"customInstructions": "Write in the imperative mood. Never reference ticket IDs in the subject.",
// o ruta a un archivo Markdown — leído cuando termina en .md y existe
"customInstructions": "~/.config/commitSage/instructions.md",
},
}
El archivo solo gana cuando el valor termina en .md y ese archivo es legible; lo demás se trata como texto literal. Una ~ inicial expande a tu home. Eso incluye una ruta .md que no existe — el valor se usa verbatim en lugar de fallar la ejecución, así un typo degrada a instrucciones literales en vez de un error.
Vacío (el default) significa que la sección se omite del todo, con cero coste de prompt. Las instrucciones personalizadas son guía permanente que defines una vez; --context es el equivalente de una sola ejecución.
Solo IA, como --context y --format — ignorado con --offline.
Idiomas personalizados
commit.commitLanguage acepta cualquier string. Seis valores tienen plantillas de formato integradas:
english · russian · chinese · japanese · german · french
Las etiquetas que normalizan a una de esas también valen — en, en-US, jp, deutsch, francais.
Lo demás es un idioma personalizado. La primera ejecución con un idioma sin traducir pregunta si traducir las instrucciones de formato, mostrando una lista checkbox con el formato pedido pre-seleccionado — pulsa Enter para traducir solo ese, o marca más para llenar la caché en la misma pasada. Traducir usa tu proveedor configurado y cuesta una llamada por formato seleccionado. Los formatos que marques más allá del pedido son best-effort: si uno falla al traducir, se omite con un aviso y la ejecución continúa con el formato pedido.
Desmarcar el formato pre-seleccionado cuenta como rechazo, igual que cancelar.
Rechazar el prompt, cancelarlo o ejecutar sin TTY cuentan como rechazo: commit-sage avisa y sale con 0, así pipes y CI nunca se bloquean por un idioma no soportado.
Las traducciones se cachean en translations.json junto a tu archivo de config, indexadas por idioma y luego formato:
{
"swahili": {
"conventional": "<translated format instructions>",
},
}
Las entradas cacheadas se usan en silencio — sin prompt en ejecuciones posteriores. Para invalidar una, bórrala: edita translations.json y elimina la entrada (el par idioma/formato, o el idioma entero), y la próxima ejecución re-traduce. No hay caducidad ni flag de refresco; una traducción cacheada queda hasta que la quites.
previous no tiene plantilla propia — imita tu historial reciente de commits — así nunca se ofrece para traducir. Reutiliza la plantilla conventional cuando hay un idioma personalizado activo.
Issue refs
commit.refs adjunta IDs de issues/tickets a los mensajes generados como línea de footer etiquetada (Refs: PROJ-123, PROJ-456):
{
"commit": {
"refs": {
"enabled": false, // interruptor maestro — solo condiciona el flujo por config; --ref/--refs siguen aplicando por ejecución
"source": "prompt", // prompt | branch | input
"value": "", // token(s) fijos para source input; separados por comas/espacios
"placement": "end", // end | start | prefix
"branchPattern": "[A-Z][A-Z0-9]*-[0-9]+", // regex sobre la rama para source branch
},
},
}
Resolución de fuente por ejecución: --ref gana a --refs, que gana a la source configurada.
promptpregunta una vez por ejecución (--refslo fuerza aunquesourceseabranchoinput). Cancelar aborta la ejecución (salida 130). Sin TTY avisa y continúa sin refs (salida 0), para no bloquear pipes ni CI.branchextrae de la rama actual conbranchPattern— el primer grupo de captura gana (ej.issue-([0-9]+)produce el número solo), si no el match completo. Un patrón inválido cae al default estilo Jira/Linear; sin match (o sin rama aún) omite refs en silencio.inputusa elcommit.refs.valuefijo, separado por comas/espacios.
Colocación: end añade línea propia debajo del mensaje (default); start antepone línea propia encima; prefix pone la línea etiquetada en la propia línea del subject (Refs: PROJ-123 feat: …) — deliberadamente sin re-truncar contra maxLength.
Los refs se adjuntan tras generar, antes de la vista previa y del handoff a --edit, para que el editor vea el texto final. Solo IA, como --format y --context — ignorado con --offline.
Contribuciones
¡Contribuciones bienvenidas! Lee CONTRIBUTING.md primero.
Formatea antes de hacer commit.
Sigue Conventional Commits para los mensajes.
Herramientas de Terceros
BizBot: AI automated promotion system
Agradecimientos
Inspirado por la extensión CommitSage para VS Code de Ivan K. (GitHub) (MIT). Motivó el port a CLI en Deno — gracias, Ivan.
Licencia
GPLv3 — ver LICENSE.