Getting started

This page assumes CodArch is already installed through one of its three paths (see Installation). The examples use the CLI; with Docker or the desktop app the result is the same cc.json, with the same checksum.

1. Analyse your repository

From the project root:

codarch analyze .

It writes the snapshot to .codarch/snapshot.cc.json: the file and folder tree, the metrics, the dependency graph and, when there is git, the history. It understands TypeScript/JavaScript, Java, Python, Go and C#; the detail is in what it analyses. See codarch analyze.

2. Open the web app

codarch serve .

The web app ships inside the CLI: serve installs nothing, it serves it locally, analyses the repo and analyses again on save. See Web app and codarch serve.

To open another repository, in the web app or the desktop app:

1. ABRIR REPOSITORIO O ARCHIVO, in the header: opens a drop-down with Analizar carpeta…, Archivo cc.json… and Reporte JSON… (for the web app’s options, see Web app).
2. Desktop only: Ctrl+O analyses a folder and Ctrl+Shift+O opens a JSON.
3. Desktop only: pass the path as an argument on start (see Desktop app).

3. Read the map

• Each block is a folder or a file. Size and colour are chosen with the ÁREA and COLOR selectors of the VISTA panel; on opening, the colour is Deuda de migración (migration debt).
• Clicking a file, the right-hand inspector shows it on its Fichero (file) tab: metrics, symbols and incoming and outgoing dependencies.
• Search finds files and symbols by name.

4. Next steps

• Write a policy in .codarch.yml and check it with codarch diff.
• Put the map on every pull request with the GitHub Action.
• Let your agent ask about the architecture with the MCP.