1
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
# Installation
2
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
3
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Requirements
4
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
5
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
- Python **3.12 or later** — required by `falkordblite`, the embedded SQLite backend
6
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
- pip 23+
7
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
8
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Install
9
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
10
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
11
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install navegador
12
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
13
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
14
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
This installs the core package with the SQLite backend (`falkordblite`) included. No external services are required for local use.
15
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
16
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Optional extras
17
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
18
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "[sqlite]"
19
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
20
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
The default. `falkordblite` is bundled and requires no configuration. This is what `pip install navegador` already gives you.
21
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
22
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
23
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[sqlite]" # explicit, same as above
24
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
25
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
26
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
!!! note
27
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
`falkordblite` requires Python 3.12+. Its embedded SQLite graph engine uses features not available in earlier Python versions.
28
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
29
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "[redis]"
30
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
31
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
For production deployments backed by a Redis instance running FalkorDB.
32
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
33
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
34
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[redis]"
35
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
36
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
37
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Then point navegador at your Redis instance:
38
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
39
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
40
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
export NAVEGADOR_DB=redis://localhost:6379
41
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador ingest ./repo
42
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
43
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
44
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
See [Configuration](configuration.md) for full Redis setup details.
45
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
46
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "[languages]"
47
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
48
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Additional tree-sitter grammars for Kotlin, C#, PHP, Ruby, Swift, C, and C++. The default install includes Python, TypeScript, JavaScript, Go, Rust, and Java.
49
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
50
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
51
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[languages]"
52
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
53
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
54
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
After installing, all 13 languages are parsed automatically by `navegador ingest`. No additional configuration is required.
55
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
56
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "[iac]"
57
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
58
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Infrastructure-as-Code parsers for HCL/Terraform, Puppet, Bash/Shell, Ansible, and Chef.
59
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
60
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
61
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[iac]"
62
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
63
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
64
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
After installing, `.tf`, `.hcl`, `.pp`, `.sh`, `.bash`, and `.zsh` files are parsed automatically. Ansible YAML files are detected heuristically by directory structure. Chef cookbooks are enriched via the Chef enricher on top of the Ruby parser.
65
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
66
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "[llm]"
67
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
68
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
LLM provider integrations for Anthropic, OpenAI, and Ollama. Required for `navegador ask`, `navegador docs`, and `navegador semantic-search`.
69
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
70
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
71
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[llm]"
72
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
73
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
74
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Configure the provider in `.navegador/config.toml` or via environment variables. See [Configuration](configuration.md) for details.
75
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
76
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
=== "all extras"
77
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
78
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Install everything at once:
79
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
80
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
81
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install "navegador[sqlite,redis,languages,iac,llm]"
82
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
83
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
84
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Verify
85
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
86
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
87
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador --version
88
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
89
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
90
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Expected output:
91
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
92
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
93
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador, version 0.8.0
94
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
95
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
96
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Shell completions
97
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
98
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
Install shell completions for tab-completion of commands and flags:
99
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
100
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
101
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador completions bash >> ~/.bashrc
102
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador completions zsh >> ~/.zshrc
103
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador completions fish > ~/.config/fish/completions/navegador.fish
104
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
105
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
106
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Python SDK
107
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
108
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
The Python SDK wraps all CLI functionality in a single `Navegador` class:
109
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
110
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```python
111
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
from navegador import Navegador
112
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
113
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
nav = Navegador(".navegador/navegador.db")
114
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
nav.ingest("./src")
115
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
bundle = nav.explain("AuthService")
116
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
print(bundle.to_markdown())
117
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
118
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
119
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
The SDK is included in the base install — no extra is required.
120
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
121
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Development install
122
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
123
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
124
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
git clone https://github.com/ConflictHQ/navegador
125
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
cd navegador
126
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install -e ".[sqlite,redis,languages,llm,dev]"
127
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
128
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
129
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
## Upgrading
130
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
131
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
132
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
pip install --upgrade navegador
133
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
134
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
135
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
After upgrading, run schema migrations first, then re-ingest to pick up new parser features:
136
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
137
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```bash
138
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador migrate # apply any schema changes from the new version
139
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador ingest ./repo # re-ingest with incremental updates (preferred)
140
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
navegador ingest ./repo --clear # full rebuild if you prefer a clean slate
141
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!
```
142
{ copied = false; pop = false }, 1000)" :class="copied && 'copied'">
Copy link Copied!