Skip to content

Configuration

Navegador has minimal required configuration. The only thing you typically need to set is where the graph database lives.


Database path

SQLite (default)

By default navegador writes a navegador.db file in the current working directory. Override with the --db flag or the NAVEGADOR_DB environment variable:

# flag (takes precedence)
navegador ingest ./repo --db ~/.navegador/myproject.db

# environment variable
export NAVEGADOR_DB=~/.navegador/myproject.db
navegador ingest ./repo

The .navegador/ directory convention keeps the database alongside your project:

my-project/
  .navegador/
    navegador.db    ← graph database
  src/
  ...

Add .navegador/ to .gitignore — the database is a build artifact, not source.

Redis (production)

For team or CI environments, point NAVEGADOR_DB at a Redis instance running FalkorDB:

export NAVEGADOR_DB=redis://localhost:6379

With authentication:

export NAVEGADOR_DB=redis://:mypassword@redis.internal:6379

Install the Redis extra if you haven't already:

pip install "navegador[redis]"

SQLite vs Redis: when to use which

SQLite (falkordblite) Redis (FalkorDB)
Setup Zero config Requires a Redis server
Use case Local dev, single developer Team, CI, shared context
Persistence Local file Redis persistence config
Performance Fast for single-user workloads Scales to large codebases
Extra required None (included) navegador[redis]

Both backends implement the same GraphStore interface. You can migrate by re-ingesting against the new backend.


GitHub token

Required for navegador wiki ingest --repo owner/repo to access private wikis or to avoid rate limits on public repos.

export GITHUB_TOKEN=ghp_...
navegador wiki ingest --repo myorg/myrepo

For public repos, wiki ingestion works without a token but will hit GitHub's unauthenticated rate limit (60 req/hr).


Environment variable reference

Variable Default Description
NAVEGADOR_DB ./navegador.db Path to SQLite file or redis:// URL
GITHUB_TOKEN GitHub personal access token for wiki ingestion

Project-local config

Drop a .navegador/config.toml in your project root for project-specific defaults (optional):

[database]
path = ".navegador/navegador.db"

[ingest]
exclude = ["node_modules", "dist", ".venv", "migrations"]

Note

.navegador/config.toml support is planned. Check navegador --version to confirm it is available in your installed version.