# cargo-teksilo
API lookup, offline documentation, and agent tooling for applications built on
[Teksilo](https://crates.io/crates/teksilo).
Install the version your application resolves (0.13.0 or later):
```sh
cargo install cargo-teksilo --version <version> --locked
```
For unpublished versions, use the matching framework checkout:
```sh
cargo install --path <checkout>/crates/cargo-teksilo --locked
```
## Commands
Run inside your application's Cargo project:
```sh
cargo teksilo symbol Button
cargo teksilo search "scrollable list"
cargo teksilo show docs/scroll-area.md
cargo teksilo init --agent codex --agent claude
cargo teksilo agent install cursor cline
cargo teksilo agent list
cargo teksilo probe install
cargo teksilo model fetch
cargo teksilo status --json
cargo teksilo --version
```
`init` installs the probe harness and agent instructions. Without `--agent`, it
uses existing configuration to detect targets. Explicit targets create their
required directories, even when no marker exists. Use `-y` to skip confirmation.
`agent install` writes instructions only, without a confirmation prompt. Targets:
`claude`, `cursor`, `windsurf`, `cline`, `copilot`, `codex`, `vibe`, `opencode`.
Claude receives a full skill; the others receive rules or a managed `AGENTS.md`
section. `--user` supports `claude`, `vibe`, and `opencode` and writes no harness.
Shared-file text outside the managed region is preserved. `--force` replaces
conflicting generated files.
`--quiet` suppresses informational messages; `--verbose` shows paths and
diagnostics. `search --json`, `status --json`, and `agent list --json` emit
structured output. API declarations and document contents are never shortened.
## Requirements
`symbol` requires Python 3. Semantic search uses ONNX Runtime and a model
(~129 MB) downloaded explicitly by `model fetch`. Until cached, search uses
BM25; neither `init` nor `search` downloads the model. The model lives in the
user cache, overridable with `FASTEMBED_CACHE_DIR`.
To build without semantic search:
```sh
cargo install cargo-teksilo --no-default-features
```
## Focused search
Use an exact type name when you know it. Matching headings receive a score bonus
of at most 10%, keeping relevance to the full query primary. Ordinary prose
queries retain the usual ranking. To exclude unrelated domains, restrict the
corpus path:
```sh
cargo teksilo search "scrolling history" --path docs/charts.md
cargo teksilo search "worker samples" --path examples/chart_demo/ --kind example
```
`--path` is a case-sensitive prefix over bundled paths, applied to both lexical
and semantic candidates before fusion. It does not search your filesystem.
An unmatched prefix returns no results. Use `show --list` to find available paths.
The app guide is also searchable at `crates/teksilo/src/app_guide.md`.
## Version matching
The tool follows the selected app's resolved dependency graph. Patch differences
produce a note; major or minor mismatches are refused. Multiple framework
versions at a virtual workspace root require running from the intended member.
For apps on different minors, install separate tools with `cargo install --root
<directory>` and select the appropriate binary on PATH.
The old `setup`, bare `probe`, and `version` commands are replaced by `init`,
`probe install`, and `--version`/`status`. `--no-model` is removed; model download
is explicit.
## License
MPL-2.0. Copyright (c) 2026 FernTech.