Renamed generic src directory to augment_indexer in example

Author: richhankins

examples/python-sdk/context/README.md

@@ -7,9 +7,7 @@ Examples demonstrating the Auggie SDK's context modes and AI-powered code analys
 1. **Python 3.10+** - Required to run the examples
 2. **Auggie CLI** - Required for FileSystem Context examples
    ```bash
-   pip install auggie
-   # or
-   npm install -g @augmentcode/auggie
+   npm install -g @augmentcode/auggie@prerelease
    ```
 3. **Authentication** - Required for all examples
    ```bash

examples/python-sdk/context/file_search_server/README.md

@@ -6,9 +6,7 @@ REST API for semantic file search with AI-powered summarization.
 
 Install the `auggie` CLI and authenticate:
 ```bash
-pip install auggie
-# or
-npm install -g @augmentcode/auggie
+npm install -g @augmentcode/auggie@prerelease
 auggie login
 ```
 

examples/python-sdk/context/github_action_indexer/.github/workflows/index.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Index repository
         id: index
-        run: python src/main.py
+        run: python -m augment_indexer.main
         env:
           AUGMENT_API_TOKEN: ${{ secrets.AUGMENT_API_TOKEN }}
           AUGMENT_API_URL: ${{ secrets.AUGMENT_API_URL }}

examples/python-sdk/context/github_action_indexer/README.md

@@ -10,11 +10,44 @@ This example demonstrates:
 - Automatic fallback to full re-index when needed
 - GitHub Actions integration
 
-## Quick Start
+## Prerequisites
 
-### Local Usage
+### Getting Your API Credentials
 
-The simplest way to get started is to index and search a repository locally:
+1. **Authenticate to get your credentials if you have not already:**
+   ```bash
+   auggie login
+   ```
+   This opens a browser for authentication and stores your credentials at `~/.augment/session.json`.
+
+2. **Extract the values for environment variables:**
+   ```bash
+   # View your session file to get the values
+   cat ~/.augment/session.json
+   ```
+   - `AUGMENT_API_TOKEN`: Use the `accessToken` value from the session file
+   - `AUGMENT_API_URL`: Use the `baseUrl` value from the session file
+
+### GitHub Token
+
+For the `GITHUB_TOKEN`, you need a GitHub Personal Access Token with `repo` scope (for private repos) or `public_repo` scope (for public repos only). [Create one here](https://github.com/settings/tokens).
+
+## Two Ways to Use This Example
+
+There are two ways to use this indexer:
+
+| Mode | Description | Best For |
+|------|-------------|----------|
+| **Local Testing** | Run from this examples directory to index any GitHub repo | Trying out the indexer, testing on existing repos |
+| **GitHub Actions** | Copy the code into your own repo for automatic indexing | Production use, CI/CD integration |
+
+---
+
+## Option 1: Local Testing (Quick Start)
+
+Test the indexer on any GitHub repository without copying any files. This downloads the repo via the GitHub API and indexes it.
+
+### Example: Index the facebook/react Repository
 
 ```bash
 # Navigate to the context examples directory
@@ -23,32 +56,47 @@ cd examples/python-sdk/context
 # Install dependencies
 pip install -r github_action_indexer/requirements.txt
 
-# Set required environment variables
-export AUGMENT_API_TOKEN="your-token"
-export AUGMENT_API_URL="https://your-tenant.api.augmentcode.com/"  # Required: your tenant-specific URL
-export GITHUB_TOKEN="your-github-token"
-export GITHUB_REPOSITORY="owner/repo"
-export GITHUB_SHA="$(git rev-parse HEAD)"
+# Set your credentials (see Prerequisites section above)
+export AUGMENT_API_TOKEN="your-token"      # From ~/.augment/session.json
+export AUGMENT_API_URL="your-url"          # From ~/.augment/session.json
+export GITHUB_TOKEN="your-github-token"    # Your GitHub PAT
+
+# Index a public repository (e.g., facebook/react)
+export GITHUB_REPOSITORY="facebook/react"
+export GITHUB_SHA="main"
 
-# Index the repository (stores state in .augment-index-state/state.json)
+# Run the indexer
 python -m github_action_indexer index
 
 # Search the indexed repository
-python -m github_action_indexer search "authentication functions"
-python -m github_action_indexer search "error handling" --max-chars 5000
+python -m github_action_indexer search "hooks implementation"
+python -m github_action_indexer search "reconciler algorithm"
 ```
 
-The index state is saved to `.augment-index-state/state.json` by default, so subsequent runs will perform incremental updates.
+### Index Your Own Repository
+
+```bash
+# Set to any repo you have access to
+export GITHUB_REPOSITORY="your-username/your-repo"
+export GITHUB_SHA="main"  # or a specific commit SHA
+
+python -m github_action_indexer index
+python -m github_action_indexer search "your search query"
+```
+
+The index state is saved to `.augment-index-state/{branch}/state.json`, so subsequent runs perform incremental updates.
+
+---
 
-## GitHub Actions Setup
+## Option 2: GitHub Actions Setup (Production Use)
 
-To automatically index your repository on every push:
+For automatic indexing of your repository on every push, copy this code into your own repository.
 
 1. **Copy the indexer code** to your repository root. The workflow expects the following structure:
    ```
    your-repo/
    ├── .github/workflows/index.yml
-   ├── src/
+   ├── augment_indexer/
    │   └── main.py (and other indexer source files)
    └── requirements.txt
    ```
@@ -128,7 +176,7 @@ Key environment variables:
 
 The index state is stored as a JSON file on the file system by default (`.augment-index-state/{branch}/state.json`). In GitHub Actions, the state is persisted between runs using GitHub Actions cache for efficient incremental updates.
 
-The indexer can be adapted to use other storage backends like Redis, S3, or databases. The state save/load operations in `src/index_manager.py` can be modified to work with any storage system that can persist JSON data.
+The indexer can be adapted to use other storage backends like Redis, S3, or databases. The state save/load operations in `augment_indexer/index_manager.py` can be modified to work with any storage system that can persist JSON data.
 
 ## Searching the Index
 

examples/python-sdk/context/github_action_indexer/__main__.py

@@ -34,11 +34,11 @@ def main() -> None:
     sys.argv = [sys.argv[0]] + sys.argv[2:]
 
     if command == "index":
-        from .src.main import main as index_main
+        from .augment_indexer.main import main as index_main
 
         index_main()
     elif command == "search":
-        from .src.search import main as search_main
+        from .augment_indexer.search import main as search_main
 
         search_main()
     else: