Probe

https://probeai.dev/docs/
Admin
Probe is an AI-powered code analysis and extraction tool that supports multiple programming...
Tokens:2,077
Snippets:11
Trust Score:4.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Probe CLI Usage Examples

Source: https://probeai.dev/docs/index

Demonstrates how to use the Probe CLI for searching code, starting an interactive AI chat, and launching the web interface. These commands allow for quick code analysis and interaction.

```bash
# Use the core Probe tool without installation
npx -y @buger/probe@latest search "error handling" ./src

# Start an interactive AI chat with your codebase
npx -y @buger/probe-chat@latest

# Start the web interface on localhost:3000
npx -y @buger/probe-chat@latest --web

```

--------------------------------

### Probe Node.js SDK - Basic Search

Source: https://probeai.dev/docs/index

Example of using the Probe Node.js SDK to search for code patterns. It demonstrates how to query for specific code and retrieve results, with options for controlling the search.

```javascript
// Example of using Probe's Node.js SDK
import { search } from '@buger/probe';

const results = await search({
  query: "error handling",
  path: "./src",
  options: {
    maxResults: 10,
    contextLines: 3,
    maxTokens: 8000  // Token-aware for AI context windows
  }
});

console.log(`Found ${results.length} matches`);

```

--------------------------------

### Probe CLI Search Examples

Source: https://probeai.dev/docs/index

Demonstrates various ways to use the Probe CLI for code searching, including natural language, token limiting, Elastic Search syntax, and code extraction by line or symbol.

```bash
# Basic search with natural language
probe search "user authentication" ./src

# Token-limited search for AI context windows
probe search "error handling" --max-tokens 8000

# Elastic search syntax with operators
probe search "(login OR auth) AND NOT test" ./src

# Extract full code just by specifying line number
probe extract src/auth.js:15 

# Extract by function/symbol name using # syntax
probe extract "src/main.rs#authenticateUser"

# Extract from unstructurred command output
go test ./... | probe extract
```

--------------------------------

### Dockerized Probe Execution

Source: https://probeai.dev/docs/index

Run Probe in a Docker container for consistent execution across environments. This example searches for the keyword 'function'.

```bash
docker run --rm -v $(pwd):/workspace buger/probe search "function"
```

--------------------------------

### Probe Search Results with JSON Output

Source: https://probeai.dev/docs/index

Example of Probe CLI search output formatted as JSON, showing file details, line numbers, node type, code snippet, and relevance score.

```json
{
  "results": [
    {
      "file": "src/error.ts",
      "lines": [10, 25],
      "node_type": "function",
      "code": "function handleApiError(error: ApiError) { ... }",
      "matched_keywords": ["error", "handle"],
      "rank": 1,
      "score": 0.95
    }
    ...
  ],
}
```

--------------------------------

### GitHub Actions CI/CD Integration

Source: https://probeai.dev/docs/index

Automate issue responses and PR reviews using Probe AI within your GitHub Actions workflow. This example triggers Probe chat for opened issues, pull requests, and comments.

```yaml
name: AI Comment Handler

on:
  pull_request:
    types: [opened]
  issue_comment:
    types: [created]
  issues:
    types: [opened]

permissions:
  issues: write
  pull-requests: write
  contents: read

jobs:
  trigger_probe_chat:
    uses: buger/probe/.github/workflows/probe.yml@main
    with:
      command_prefix: "/probe"
    secrets:
      ANTHROPIC_API_KEY: ${{ secrets.API_KEY }}
      

```

--------------------------------

### AI Chat with Probe CLI

Source: https://probeai.dev/docs/index

Launch the AI chat mode using the Probe CLI. This requires an API key for OpenAI or Anthropic.

```bash
npx -y @buger/probe-chat@latest --web
```

--------------------------------

### Probe CLI Extraction from Test Output

Source: https://probeai.dev/docs/index

Demonstrates how Probe CLI can extract code snippets from command output, such as test failures, by parsing the input and identifying relevant code blocks.

```go
$ go test ./... | probe extract
## File: user_auth_test.go
Lines: 56-62
```
function TestUserAuth(t *testing.T) {
  user := createTestUser()
  token, err := authenticateUser(user.credentials)
  assert.NoError(t, err)
  assert.NotEmpty(t, token)
}
```
```

--------------------------------

### Core Search with Probe CLI

Source: https://probeai.dev/docs/index

Execute a basic search query using the Probe CLI. This command searches for code related to 'stemming' and '-lexer' within the codebase.

```bash
npx -y @buger/probe@latest "+stemming -lexer"
```

--------------------------------

### Probe Node.js SDK with LangChain Integration

Source: https://probeai.dev/docs/index

Integrates Probe's search functionality with LangChain to create an AI assistant that can understand and query your codebase. This allows the AI to answer questions based on code context.

```javascript
import { search } from '@buger/probe';
import { ChatOpenAI } from '@langchain/openai';
import { tools } from '@buger/probe';

// Create AI assistant with code search capability
const searchTool = tools.createSearchTool();
const model = new ChatOpenAI()
  .withTools([searchTool]);

// Ask questions about your codebase
const result = await model.invoke([
  { role: "system",
    content: "You are a code assistant." },
  { role: "user",
    content: "How is error handling implemented?" }
]);

```

--------------------------------

### Probe CLI Advanced Pattern Matching

Source: https://probeai.dev/docs/index

Utilizes the Probe CLI for advanced, AST-aware pattern matching. This allows searching for specific code structures, including placeholders for variables and code blocks.

```bash
# Find all try/catch blocks
probe query -p "try $$$BODY catch ($ERROR) $$$HANDLER" ./src

# Find all React useEffect hooks with dependencies
probe query -p "useEffect(() => $$$BODY, [$$$DEPS])" ./src

# Find all functions that call a specific method
probe query -p "function $NAME($$$) { $$$; fetchData($$$); $$$; }" ./src

```
Tokens:
Raw