Update CLAUDE.md with joeyking docs tool documentation
Some checks failed
Regenerate Documentation Index / regenerate-index (push) Failing after 7s
Some checks failed
Regenerate Documentation Index / regenerate-index (push) Failing after 7s
This commit is contained in:
parent
54de1e33d8
commit
5f3fd67a41
1 changed files with 45 additions and 11 deletions
56
CLAUDE.md
56
CLAUDE.md
|
|
@ -45,7 +45,7 @@ See the root `CLAUDE.md` for full session documentation template and ITFlow tick
|
||||||
| URL | dbits.ca/docs |
|
| URL | dbits.ca/docs |
|
||||||
| Repo | git.dbits.ca/digiBandit/digiDocs |
|
| Repo | git.dbits.ca/digiBandit/digiDocs |
|
||||||
| Type | Public documentation (Markdown) |
|
| Type | Public documentation (Markdown) |
|
||||||
| Doc Count | 73 documents |
|
| Doc Count | 82 documents |
|
||||||
| Index | `.docs-index.json` |
|
| Index | `.docs-index.json` |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -138,31 +138,65 @@ Each folder contains a `README.md` with a table of contents.
|
||||||
**jk.dbits.ca** is the central Claude brain. See root CLAUDE.md for full details.
|
**jk.dbits.ca** is the central Claude brain. See root CLAUDE.md for full details.
|
||||||
|
|
||||||
- **Query business data**: ITFlow tickets/clients, TRMM agents/scripts, Forgejo repos
|
- **Query business data**: ITFlow tickets/clients, TRMM agents/scripts, Forgejo repos
|
||||||
|
- **Search documentation**: Semantic search across digiDocs and digiDocs_internal
|
||||||
- **Trigger automations**: n8n workflows, TRMM script execution
|
- **Trigger automations**: n8n workflows, TRMM script execution
|
||||||
- **Shared context**: Cross-session memory and state
|
- **Shared context**: Cross-session memory and state
|
||||||
- **API**: `https://jk.dbits.ca/api/tool` (coming soon for Claude Code integration)
|
- **API**: `https://jk.dbits.ca/api/tool`
|
||||||
|
|
||||||
### Using joeyking CLI
|
### Docs Search Tool
|
||||||
|
|
||||||
Query business systems directly from Claude Code:
|
joeyking provides semantic documentation search via the `docs` tool:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Search by category
|
||||||
|
joeyking.sh docs search_docs '{"repo": "digiDocs", "category": "security"}'
|
||||||
|
|
||||||
|
# Search by keyword
|
||||||
|
joeyking.sh docs search_docs '{"repo": "digiDocs", "keyword": "backup"}'
|
||||||
|
|
||||||
|
# Search with tags
|
||||||
|
joeyking.sh docs search_docs '{"repo": "digiDocs", "tags": ["mits", "services"]}'
|
||||||
|
|
||||||
|
# Combined search
|
||||||
|
joeyking.sh docs search_docs '{"repo": "digiDocs", "category": "services", "keyword": "device", "limit": 5}'
|
||||||
|
|
||||||
|
# Get full document content
|
||||||
|
joeyking.sh docs get_doc '{"repo": "digiDocs", "path": "Services/Device_Management.md"}'
|
||||||
|
|
||||||
|
# List categories with counts
|
||||||
|
joeyking.sh docs list_categories '{"repo": "digiDocs"}'
|
||||||
|
|
||||||
|
# List tags with counts
|
||||||
|
joeyking.sh docs list_tags '{"repo": "digiDocs"}'
|
||||||
|
```
|
||||||
|
|
||||||
|
**Operations:**
|
||||||
|
| Operation | Description |
|
||||||
|
|-----------|-------------|
|
||||||
|
| `search_docs` | Search by category, tags, and/or keyword |
|
||||||
|
| `get_doc` | Get full document content with metadata |
|
||||||
|
| `list_categories` | List all categories with doc counts |
|
||||||
|
| `list_tags` | List all tags with usage counts |
|
||||||
|
|
||||||
|
### Other joeyking Tools
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# List available tools
|
# List available tools
|
||||||
/run/media/deck/Storage/2026/joeyking.sh tools
|
joeyking.sh tools
|
||||||
|
|
||||||
# ITFlow queries
|
# ITFlow queries
|
||||||
/run/media/deck/Storage/2026/joeyking.sh itflow get_ticket '{"ticket_id": "t260045"}'
|
joeyking.sh itflow get_ticket '{"ticket_id": "t260045"}'
|
||||||
/run/media/deck/Storage/2026/joeyking.sh itflow list_clients
|
joeyking.sh itflow list_clients
|
||||||
|
|
||||||
# TRMM queries
|
# TRMM queries
|
||||||
/run/media/deck/Storage/2026/joeyking.sh trmm list_agents '{"client_name": "ClientName"}'
|
joeyking.sh trmm list_agents '{"client_name": "ClientName"}'
|
||||||
|
|
||||||
# Forgejo queries
|
# Forgejo queries
|
||||||
/run/media/deck/Storage/2026/joeyking.sh forgejo list_repos
|
joeyking.sh forgejo list_repos
|
||||||
/run/media/deck/Storage/2026/joeyking.sh forgejo get_file '{"repo": "digiDocs", "path": "README.md"}'
|
joeyking.sh forgejo get_file '{"repo": "digiDocs", "path": "README.md"}'
|
||||||
|
|
||||||
# Cross-session context
|
# Cross-session context
|
||||||
/run/media/deck/Storage/2026/joeyking.sh context get
|
joeyking.sh context get
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue