Examples for the TypeScript context SDK

Author: igor0

examples/typescript-sdk/context/README.md

@@ -0,0 +1,46 @@
+# Context Examples
+
+Examples demonstrating the Auggie SDK's context modes and AI-powered code analysis.
+
+## Examples
+
+### [Direct Context](./direct-context/)
+API-based indexing with semantic search and AI Q&A.
+
+```bash
+auggie login
+npx tsx examples/context/direct-context/index.ts
+```
+
+### [FileSystem Context](./filesystem-context/)
+Local directory search via MCP protocol.
+
+```bash
+npx tsx examples/context/filesystem-context/index.ts
+```
+
+### [File Search Server](./file-search-server/)
+REST API for semantic file search with AI summarization.
+
+```bash
+export AUGMENT_API_TOKEN="your-token"
+npx tsx examples/context/file-search-server/index.ts .
+curl "http://localhost:3000/search?q=typescript"
+```
+
+### [Prompt Enhancer Server](./prompt-enhancer-server/)
+HTTP server that enhances prompts with codebase context.
+
+```bash
+npx tsx examples/context/prompt-enhancer-server/index.ts .
+curl -X POST http://localhost:3001/enhance \
+  -H "Content-Type: application/json" \
+  -d '{"prompt": "fix the login bug"}'
+```
+
+## Setup
+
+1. Build the SDK: `npm run build`
+2. Authenticate: `auggie login` or set `AUGMENT_API_TOKEN`
+3. For FileSystem Context: Install `auggie` CLI
+

examples/typescript-sdk/context/direct-context/README.md

@@ -0,0 +1,29 @@
+# Direct Context Example
+
+API-based indexing with semantic search, AI Q&A, and state persistence.
+
+## Usage
+
+```bash
+# Authenticate
+auggie login
+
+# Run the example
+npx tsx examples/context/direct-context/index.ts
+```
+
+## What It Does
+
+- Creates a Direct Context instance
+- Adds sample files to the index
+- Performs semantic searches
+- Uses `searchAndAsk()` for AI-powered Q&A
+- Generates documentation
+- Exports/imports context state
+
+## Key Features
+
+- **`search()`**: Semantic search returning formatted code snippets
+- **`searchAndAsk()`**: One-step AI Q&A about indexed code
+- **State persistence**: Export/import index for reuse
+

examples/typescript-sdk/context/direct-context/index.ts

@@ -0,0 +1,152 @@
+/**
+ * Sample: Direct Context - API-based indexing with import/export state
+ *
+ * This sample demonstrates:
+ * - Creating a Direct Context instance
+ * - Adding files to the index
+ * - Searching the indexed files
+ * - Using Generation API to ask questions about indexed code
+ * - Generating documentation from indexed code
+ * - Exporting state to a file
+ * - Importing state from a file
+ */
+
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { DirectContext } from "@augmentcode/auggie-sdk";
+
+async function main() {
+  console.log("=== Direct Context Sample ===\n");
+
+  // Create a Direct Context instance
+  // Authentication is automatic via:
+  // 1. AUGMENT_API_TOKEN / AUGMENT_API_URL env vars, or
+  // 2. ~/.augment/session.json (created by `auggie login`)
+  console.log("Creating Direct Context...");
+  const context = await DirectContext.create({ debug: true });
+
+  // Add some sample files to the index
+  console.log("\nAdding files to index...");
+  const files = [
+    {
+      path: "sample/calculator.ts",
+      contents: `export class Calculator {
+  add(a: number, b: number): number {
+    return a + b;
+  }
+
+  subtract(a: number, b: number): number {
+    return a - b;
+  }
+
+  multiply(a: number, b: number): number {
+    return a * b;
+  }
+
+  divide(a: number, b: number): number {
+    if (b === 0) throw new Error("Division by zero");
+    return a / b;
+  }
+}`,
+    },
+    {
+      path: "sample/utils.ts",
+      contents: `export function formatNumber(num: number): string {
+  return num.toLocaleString();
+}
+
+export function isEven(num: number): boolean {
+  return num % 2 === 0;
+}
+
+export function clamp(value: number, min: number, max: number): number {
+  return Math.min(Math.max(value, min), max);
+}`,
+    },
+    {
+      path: "sample/main.ts",
+      contents: `import { Calculator } from "./calculator";
+import { formatNumber } from "./utils";
+
+const calc = new Calculator();
+const result = calc.add(10, 20);
+console.log("Result:", formatNumber(result));`,
+    },
+  ];
+
+  const result = await context.addToIndex(files);
+  console.log("\nIndexing result:");
+  console.log("  Newly indexed:", result.newlyIndexed);
+  console.log("  Already indexed:", result.alreadyIndexed);
+
+  // Search the codebase - returns formatted string ready for LLM use or display
+  console.log("\n--- Search 1: Find calculator functions ---");
+  const results1 = await context.search("calculator functions for arithmetic");
+  console.log("Search results:");
+  console.log(results1);
+
+  console.log("\n--- Search 2: Find utility functions ---");
+  const results2 = await context.search("utility functions");
+  console.log("Search results:");
+  console.log(results2);
+
+  // Use searchAndAsk to ask questions about the indexed code
+  console.log("\n--- searchAndAsk Example 1: Ask questions about the code ---");
+  const question = "How does the Calculator class handle division by zero?";
+  console.log(`Question: ${question}`);
+
+  const answer = await context.searchAndAsk(
+    "division by zero error handling",
+    question
+  );
+
+  console.log(`\nAnswer: ${answer}`);
+
+  // Use searchAndAsk to generate documentation
+  console.log("\n--- searchAndAsk Example 2: Generate documentation ---");
+  const documentation = await context.searchAndAsk(
+    "Calculator class methods",
+    "Generate API documentation in markdown format for this code"
+  );
+
+  console.log("\nGenerated Documentation:");
+  console.log(documentation);
+
+  // Use searchAndAsk to explain code patterns
+  console.log("\n--- searchAndAsk Example 3: Explain code patterns ---");
+  const explanation = await context.searchAndAsk(
+    "utility functions",
+    "Explain what these utility functions do and when they would be useful"
+  );
+
+  console.log(`\nExplanation: ${explanation}`);
+
+  // Export state to a file
+  const stateFile = join("/tmp", "direct-context-state.json");
+  console.log(`\nExporting state to ${stateFile}...`);
+  await context.exportToFile(stateFile);
+  console.log("State exported successfully");
+
+  // Show the exported state
+  const exportedState = JSON.parse(readFileSync(stateFile, "utf-8"));
+  console.log("\nExported state:");
+  console.log(JSON.stringify(exportedState, null, 2));
+
+  // Import state in a new context
+  console.log("\n--- Testing state import ---");
+  const context2 = await DirectContext.create({ debug: false });
+  await context2.importFromFile(stateFile);
+  console.log("State imported successfully");
+
+  // Verify we can still search
+  const results3 = await context2.search("division by zero");
+  console.log("\nSearch after importing state:");
+  console.log(results3);
+
+  console.log("\n=== Sample Complete ===");
+}
+
+main().catch((error) => {
+  console.error("Error:", error);
+  process.exit(1);
+});

examples/typescript-sdk/context/file-search-server/README.md

@@ -0,0 +1,45 @@
+# File Search Server Example
+
+REST API for semantic file search with AI-powered summarization and code explanation.
+
+## Prerequisites
+
+Install the `auggie` CLI:
+```bash
+auggie --version
+```
+
+## Usage
+
+```bash
+export AUGMENT_API_TOKEN="your-token"
+npx tsx examples/context/file-search-server/index.ts .
+```
+
+## API Endpoints
+
+### Search Files
+```bash
+curl "http://localhost:3000/search?q=typescript"
+curl "http://localhost:3000/search?q=package.json&format=text"
+```
+
+### Summarize (AI)
+```bash
+curl -X POST http://localhost:3000/summarize \
+  -H "Content-Type: application/json" \
+  -d '{"query":"authentication logic"}'
+```
+
+### Explain Code (AI)
+```bash
+curl -X POST http://localhost:3000/explain \
+  -H "Content-Type: application/json" \
+  -d '{"path":"src/auth.ts"}'
+```
+
+### Health Check
+```bash
+curl "http://localhost:3000/health"
+```
+