Navegador

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

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button