# pi-lens
pi-lens gives AI coding agents fast, language-aware feedback while they write/edit.
## What It Does
- LSP diagnostics and navigation across supported languages
- Impact cascade diagnostics that show which related files were affected and run LSP diagnostics on them
- Language-specific linters, type-checkers, and scanners on every write/edit
- Safe formatting/autofix where tools are configured or confidently detected
- ast-grep and tree-sitter structural rules for correctness/security smells
- Agent-facing tools for LSP navigation/diagnostics, AST search/replace,
diagnostics state, and project intelligence
- Review-graph intelligence for supported languages via bundled tree-sitter WASMs
- Ranked identifier search (`symbol_search`) over an always-warm word index,
feeding the discovery funnel (symbol_search → module_report → read_symbol)
- Read-guard and edit-autopatch support to reduce bad edits
- Background security/dependency scans for opted-in projects
## Install
```bash
pi install npm:pi-lens
```
Or from git:
```bash
pi install git:github.com/apmantza/pi-lens
```
## Documentation
- [Agent tools](docs/agent-tools.md) — pi tool names, scopes, and arguments
- [Usage guide](docs/usage.md) — lifecycle, tool behavior, MCP notes, and
troubleshooting
- [Features](docs/features.md) — detailed feature reference
- [Word index](docs/word-index.md) — identifier search (`symbol_search`) and
the discovery funnel
- [Tools and commands](docs/tools.md) — runtime flags and slash commands
- [Configuration](docs/globalconfig.md) — global and project config files
- [Environment variables](docs/env_variables.md) — common env vars and full
reference link
- [Language coverage](docs/language-coverage.md) — supported languages, runners,
and formatters
- [Dependencies](docs/dependencies.md) — auto-install policy and external tools
- [Custom rules](docs/custom-rules.md) — project ast-grep and tree-sitter rules
## Contributing
See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow, runner,
LSP, formatter, and rule checklists, and issue/PR conventions.
Security issues should be reported privately; see [`SECURITY.md`](SECURITY.md).
pi-lens is released under the [MIT License](LICENSE).
## Contributors
Thanks goes to these wonderful people:
