Ir al contenido
CodArchel mapa vivo de la arquitectura
ESEN

Instalación

CodArch se instala de tres formas. Elige la que encaje con cómo trabajas; las tres leen tu repositorio en local y no suben código a ningún sitio.

FormaQué obtienesRequisitos
npmCLI codarch + webapp servida con codarch serveNode.js 22 o superior
DockerSolo la webapp, en un contenedorDocker
EscritorioApp nativa para Windows o LinuxWindows x64, o Linux x64 (.deb o AppImage)

El paquete codarch de npm trae el CLI y la webapp ya compilada dentro: una sola instalación.

Ventana de terminal
npm i -g codarch

El paquete declara "engines": { "node": ">=22" }. Comprueba tu versión con node --version.

Comprueba la instalación y abre la webapp sobre un repositorio:

Ventana de terminal
codarch --version
cd ruta/a/tu-repo
codarch serve .

serve analiza el repositorio, sirve la app en http://127.0.0.1:4173 y la refresca cuando cambian los ficheros.

Terminal con codarch serve . en marcha y la webapp abierta en el navegador

Todas las opciones están en codarch serve.

La imagen ghcr.io/jaminsmoke/codarch-web es una instalación de codarch con la webapp dentro. Arranca codarch serve /workspace --host 0.0.0.0 --port 4173, así que solo hay que montar el repositorio en /workspace y publicar el puerto 4173:

Ventana de terminal
docker run --rm \
-p 127.0.0.1:4173:4173 \
-v "$PWD:/workspace:ro" \
ghcr.io/jaminsmoke/codarch-web:latest

En PowerShell, usa -v "${PWD}:/workspace:ro". Después abre http://127.0.0.1:4173.

  • El montaje es de solo lectura (:ro): la app no escribe en tu repositorio.
  • Publica el puerto solo en 127.0.0.1: no es un servicio de red.
  • La imagen trae git para leer el churn y el historial, y un healthcheck sobre /data/meta.json.
  • Cada release publica dos etiquetas: latest y la versión exacta (por ejemplo 0.3.36).

Con Docker Compose (si has clonado el repositorio)

Sección titulada «Con Docker Compose (si has clonado el repositorio)»

El docker-compose.yml del repositorio construye la imagen desde el código fuente. Es para quien trabaja con un clon de CodArch; para usar la app basta con docker run. La variable CODARCH_REPO es la ruta del host que se monta en /workspace (por defecto, la carpeta actual):

Ventana de terminal
CODARCH_REPO=/ruta/a/tu-repo docker compose up --build

CODARCH_REPO solo la lee Compose; el contenedor no la usa. Con docker run, la ruta se indica en -v.

Descarga el instalador de la última release en GitHub Releases:

SistemaFicheroNotas
Windows x64codarch-<versión>-setup.exeInstalador NSIS, por usuario; permite elegir carpeta y crea accesos directos.
Linux x64codarch-<versión>-amd64.debSe instala en el sistema (sudo apt install ./codarch-….deb).
Linux x64codarch-<versión>-x86_64.AppImageSin instalación: chmod +x y ejecutar.

Los instaladores no están firmados: Windows SmartScreen puede avisar al abrir el .exe («Más información» → «Ejecutar de todas formas»). macOS no tiene instalador todavía.