android-docs-search
Scannednpx machina-cli add skill tamtom/android-docs-claude-plugin/android-docs-search --openclawAndroid Docs Search
Overview
Search the local Android/Kotlin documentation. The documentation must be installed separately (see plugin README).
Default location: ~/StudioProjects/android-docs-claude-plugin/docs/
Two search methods available:
- SQLite index - Fast API name lookups (189,506+ indexed entries)
- Grep/Read - Full-text search in HTML documentation content
When to Use Each Method
| Method | Use For |
|---|---|
| SQLite | Finding classes, functions, properties by name |
| Grep | Searching documentation content, deprecation notices, examples |
SQLite Index Search
Database location: ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db
Table Schema
CREATE TABLE api_index(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);
Entry Types
Class, Constructor, Property, Package, Annotation, Function, Enum, Constant, Object, Interface, Method
Search Examples
# Find by exact name
sqlite3 ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db \
"SELECT name, type, path FROM api_index WHERE name LIKE '%LazyColumn%';"
# Filter by type
sqlite3 ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db \
"SELECT name, type FROM api_index WHERE name LIKE '%Modifier%' AND type='Class';"
# Find all entries in a package
sqlite3 ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db \
"SELECT name, type FROM api_index WHERE name LIKE 'androidx.compose.material3%';"
Content Search (Grep)
Documentation location: ~/StudioProjects/android-docs-claude-plugin/docs/Documents/developer.android.com/
Search Examples
Use the Grep tool to search HTML files:
pattern: "deprecated"
path: ~/StudioProjects/android-docs-claude-plugin/docs/Documents/
glob: "*.html"
Or get context around a match:
pattern: "LocalAutofillTree"
path: <file_path_from_sqlite>
output_mode: "content"
-A: 10
-B: 2
Recommended Workflow
- Start with SQLite to find the API and its file path
- Use Grep/Read to examine the actual documentation content
Example: Find deprecation info for an API
# Step 1: Find the file
sqlite3 ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db \
"SELECT name, path FROM api_index WHERE name LIKE '%LocalAutofillTree%';"
# Step 2: Read the deprecation notice from the file using Read or Grep tool
Documentation Structure
~/StudioProjects/android-docs-claude-plugin/
├── docs/
│ ├── android_api_index.db # SQLite index (189,506+ entries)
│ └── Documents/
│ └── developer.android.com/
│ └── reference/
│ ├── android/ # Java Android APIs
│ └── kotlin/ # Kotlin Android APIs
│ └── androidx/ # AndroidX libraries
├── scripts/
│ ├── bulk_updater.py # Sync new pages from developer.android.com
│ ├── download_and_process.py # Download single pages
│ └── update_index.py # Manage SQLite index
└── skills/
└── android-docs-search/
└── SKILL.md
Keeping Docs Updated
Run from the docs/ directory:
# Check for new pages
python3 ../scripts/bulk_updater.py discover
python3 ../scripts/bulk_updater.py diff
# Download new pages
python3 ../scripts/bulk_updater.py sync
# Rebuild search index
python3 ../scripts/update_index.py rebuild
Source
git clone https://github.com/tamtom/android-docs-claude-plugin/blob/main/skills/android-docs-search/SKILL.mdView on GitHub Overview
Android Docs Search lets you query local Android/Kotlin documentation installed separately. It combines a fast SQLite index for API-name lookups with a Grep-based full-text search for content, deprecations, and examples. Use it to explore Android APIs, Compose components, AndroidX classes, and Kotlin extensions offline.
How This Skill Works
Two search methods are provided: a SQLite index for quick API-name lookups and a Grep-based search for full-text content. The SQLite index is stored at ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db and returns name, type, and path. After locating the API path with SQL, you inspect the actual documentation content under docs/Documents/developer.android.com using Read or Grep to view HTML pages and related notes.
When to Use It
- You need to find an API, class, or function by name (fast lookup).
- You want full documentation content, deprecation notes, or usage examples offline.
- You’re working with Android APIs, Compose components, or AndroidX classes and need local references.
- You’re looking for Kotlin extensions or package-level documentation offline.
- You want to verify or browse documentation without internet access.
Quick Start
- Step 1: Start with SQLite to locate the API name, type, and file path in ~/StudioProjects/android-docs-claude-plugin/docs/android_api_index.db.
- Step 2: Open the identified HTML/MD pages under ~/StudioProjects/android-docs-claude-plugin/docs/Documents/ to read content with Read or Grep.
- Step 3: If docs are out of date, run the project scripts from the docs/ directory to discover, diff, sync, and rebuild the index.
Best Practices
- Start with the SQLite index to locate the API name, type, and file path quickly.
- Use Grep/Read after locating the file to review actual docs and examples.
- Keep the local docs up to date by running the project’s update scripts regularly.
- Filter results by type when you know you’re looking for a specific entry (e.g., Class, Function).
- Note the default documentation location and package paths to speed up future searches.
Example Use Cases
- Find the path and type for LocalAutofillTree, then read its deprecation notes from the associated HTML page.
- Lookup a Compose API name (e.g., Modifier) to confirm its Class type and source package.
- List all entries under a package like androidx.compose.material3 to explore available components.
- Search for a deprecation message within a specific API’s documentation using Grep.
- Locate a Kotlin extension function’s documentation and examples offline for reference.
