This guide helps you navigate the Probe documentation and find the information you need.
The Probe documentation is organized into three main sections:
This section covers what Probe is, how to install it, and key concepts.
- What is Probe? - Overview of Probe's core features, local privacy, and AI readiness
- Installation - Detailed installation instructions for all platforms
- Quick Start - Get up and running with Probe in minutes
- Language Support - How Probe understands different languages
- Supported Languages - List of supported programming languages
- How It Works - The technology behind Probe
This section shows how different user roles can integrate Probe into their workflow.
- Using with AI Code Editors - MCP integration and editor plugin setups
- Using in the CLI for Advanced AI - CLI usage, scripting, and session-based caching
- Hosting a Team Chat - Web interface usage and network configuration
- Building AI Tools with Node.js SDK - SDK usage, LangChain, and custom tool building
This section provides comprehensive reference for all commands, flags, APIs, etc.
- CLI Reference - Command-line interface reference with all flags
- AI Integration Reference - Environment variables, supported models, and usage patterns
- MCP Server Reference - JSON schemas and tool call specifications
- Output Formats Reference - JSON, XML, and other output formats
- Search Functionality - Detailed search capabilities
- Code Extraction - Extract meaningful code blocks
- Adding Languages - Contribute support for new languages
- Documentation Maintenance - For documentation maintainers
- Contributing Guide - How to contribute to Probe
- Code of Conduct - Community guidelines
If you're new to Probe, we recommend following this path:
- Start with What is Probe? to understand the tool's capabilities
- Follow the Installation guide to get Probe set up
- Use the Quick Start guide to get up and running quickly
- Choose a workflow that matches your needs from the Use Cases section
- Refer to the Reference Documentation for detailed information as needed
- AI Code Editor Users: Start with Using with AI Code Editors
- CLI Power Users: Check out Using in the CLI for Advanced AI
- Enterprise/Team Users: See Hosting a Team Chat
- AI Tooling Developers: Begin with Building AI Tools with Node.js SDK
There are several ways to find information in the documentation:
- Navigation Menu: Use the sidebar navigation to browse the documentation by section
- Search: Use the search box in the top right to find specific topics
- Cross-References: Follow links within documentation pages to related topics
- Home Page: The home page provides an overview of key features
Throughout the documentation, we use the following conventions:
Code examples are shown in code blocks:
probe search "error handling" ./srcCommand examples are shown using the <CommandExample> component:
probe search "error handling" ./src
Code snippets are shown using the <CodeEditor> component:
Important information is highlighted using note blocks:
:::info This is an informational note that provides additional context. :::
:::warning This is a warning that highlights potential issues or important considerations. :::
:::tip This is a tip that provides helpful advice or best practices. :::
We welcome contributions to the Probe documentation. If you find errors, omissions, or have suggestions for improvements, please consider contributing:
- Fork the Probe repository on GitHub
- Make your changes to the documentation files in the
sitedirectory - Submit a pull request with your changes
For more information on contributing, see the Contributing Guide.
If you have feedback on the documentation, please open an issue on GitHub or reach out to the maintainers.