Instalación
Esta guía instala codeknit desde el código fuente, lo añade a tu PATH, habilita las completaciones de shell y verifica que funcione.
Instalar desde el código fuente
Sección titulada «Instalar desde el código fuente»Requisitos previos
- Go 1.26 o posterior
- Un compilador C. codeknit usa CGo para compilar sus analizadores tree-sitter.
Pasos
git clone https://github.com/awslabs/codeknit.gitcd codeknitmake buildEl binario se guarda en ./bin/codeknit.
Usar un binario precompilado en su lugar
Sección titulada «Usar un binario precompilado en su lugar»Los binarios precompilados para Linux, macOS y Windows (amd64 y arm64) están disponibles en la página de versiones. Descarga el archivo para tu plataforma, extráelo y mueve el binario a tu PATH. Cada versión incluye un archivo checksums.txt con el que puedes verificar la descarga.
Añadir codeknit a tu PATH
Sección titulada «Añadir codeknit a tu PATH»Omite esta sección si ya moviste el binario a un directorio que esté en tu PATH, como /usr/local/bin.
Reemplaza /path/to/codeknit con el directorio que contiene el binario. Si compilaste desde el código fuente, este es el directorio bin dentro del repositorio clonado.
Añade la línea correspondiente a tu shell en su archivo de configuración:
# bash (~/.bashrc)export PATH="$PATH:/path/to/codeknit"
# zsh (~/.zshrc)export PATH="$PATH:/path/to/codeknit"
# fish (~/.config/fish/config.fish)fish_add_path /path/to/codeknitRecarga tu shell o carga el archivo que editaste:
source ~/.bashrc # bashsource ~/.zshrc # zshPara fish, abre una nueva terminal.
Habilitar completaciones de shell
Sección titulada «Habilitar completaciones de shell»codeknit genera scripts de completación para bash, zsh, fish y PowerShell. Ejecuta el comando correspondiente a tu shell una vez:
# bashcodeknit completion bash >> ~/.bashrc
# zshcodeknit completion zsh >> ~/.zshrc
# fishcodeknit completion fish > ~/.config/fish/completions/codeknit.fish
# PowerShellcodeknit completion powershell >> $PROFILELos comandos para bash, zsh y PowerShell añaden el script a tu perfil. Ejecutarlos de nuevo lo añadirá una segunda vez, así que ejecuta cada uno solo una vez.
Abre un nuevo shell o carga tu perfil para activar las completaciones.
Verificar la instalación
Sección titulada «Verificar la instalación»codeknit --versionSi el comando muestra una versión, codeknit está instalado. Si tu shell reporta command not found, verifica que el directorio en tu línea PATH contenga el binario codeknit, luego recarga tu shell.
Configurar un entorno de desarrollo
Sección titulada «Configurar un entorno de desarrollo»Haz esto solo si planeas contribuir a codeknit. Ejecuta estos comandos desde la raíz del repositorio clonado:
make deps # instala dependenciasmake setup # configura git hooksmake test # ejecuta la suite de pruebasmake lint ejecuta el linter y el formateador.
Próximos pasos
Sección titulada «Próximos pasos»- Ejecuta tu primer comando en Introducción.
- Explora todas las opciones en la referencia de flags de la CLI.