Troubleshooting
Start with installation, connections, and bundled resources.
crux is not found
Open a new terminal and run crux --version. The default directory is ~/.crux/bin; if you used --no-modify-path, add it to PATH yourself. The Windows installer needs a bash environment; a bash pipeline is not directly interchangeable with PowerShell syntax.
The model will not connect
- Check the provider and credentials with /provider, then confirm the model with /model.
- Check quota, model access, and the configured API endpoint.
- Check the network and proxy settings. System-proxy fallback cannot resolve every network restriction.
- Include a redacted error when reporting a problem, never an API key or login token.
No TLDR or quota information
TLDR needs a working auxiliary model, and automatic summaries also depend on answer length. Check /auxiliary, then try /tldr. Coding-plan usage is available only for supported, successfully connected providers; missing data is not zero quota.
A plugin is missing
Check TOML syntax under .crux/plugins, matching id and filename, and placement. Wait for the next scan. Status paths resolve relative to the project root. Try the minimal manual example before adding an external source.
First semantic search is slow
First use may need model downloads and indexing. Check networking and model assets, then compare later queries. Keep third_party resources in their packaged relative locations.
Report an issue
Include the Crux version, OS, terminal, reproduction steps, and redacted output in a GitHub issue. Say whether the problem occurs during startup, interaction, model responses, or tool execution.