Joseph Doherty
32f26272ae
Five tools under one repo, all docs organized per DOCS-GUIDE.md: - aalogcli: .NET 4.8 / x86 CliFx CLI for reading System Platform binary logs (*.aaLGX) for LLM debugging, built on aaOpenSource/aaLog. Commands: last, tail, range, unread, fields. Stable JSON envelope under --llm-json. Build template under lib/build/ for rebuilding aaLogReader.dll. - aot: ArchestrA Object Toolkit 2014 v4.0 reference material. Dev guide (Markdown converted from CHM), API reference for the ArchestrA.Toolkit namespace, and the Monitor / Watchdog VS sample solutions. - graccesscli: .NET 4.8 / x86 CliFx CLI that automates Galaxy configuration via the ArchestrA GRAccess COM interop. Includes session daemon, IPC protocol, and llm-json envelope contract. - grdb: SQL/DDL exploration of the Galaxy Repository database. DDL captures, reusable queries, hierarchy / contained-name <-> tag-name translation notes. - histdb: LLM-oriented reference for AVEVA Historian retrieval. INSQL linked-server, extension tables, every wwXxx time-domain extension, every retrieval mode, alarm/event SQL recipes, REST API. Distilled from the 243-page Historian Retrieval Guide. Root contains: - CLAUDE.md: thin index pointing into each tool's README. - DOCS-GUIDE.md: doctrine for organizing docs for LLM consumption. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
18 lines
1.5 KiB
Markdown
18 lines
1.5 KiB
Markdown
# GRAccess CLI Documentation
|
|
|
|
This folder stores user-facing and implementation reference documentation for `graccess_cli`.
|
|
|
|
- `usage.md` - CLI commands, options, session mode, IPC protocol, and expanded command surface. Update this whenever user-facing commands change.
|
|
- `llm-integration.md` - implemented LLM-facing operating contract, stable envelope, safety rules, validation, batch plans, and IDE intent wrappers.
|
|
- `adding-features.md` - contributor checklist for adding commands, dispatcher handlers, LLM output, validation, tests, and documentation.
|
|
- `zb-galaxy.md` - read-only documentation captured from the live `ZB` galaxy with `graccess_cli`.
|
|
- `zb-testmachine.md` - deep read-only documentation of the `ZB` `$TestMachine` template family and instances.
|
|
- `template-parsing.md` - read-only workflow for inspecting existing templates such as `TestMachine`.
|
|
- `attribute-parsing.md` - detailed workflow for parsing all template attributes and setting families.
|
|
- `script-parsing.md` - workflow for parsing script libraries and object-level scripts.
|
|
- `template-editing.md` - end-to-end workflow for safely editing existing templates.
|
|
- `template-instance-editing.md` - workflow for creating and editing template instances, areas, engine assignments, and I/O settings.
|
|
- `attribute-editing.md` - detailed workflow for editing template attributes, UDAs, extensions, and setting families.
|
|
- `script-editing.md` - workflow for editing script libraries and script-bearing template content.
|
|
- `clifx_reference.md` - local CliFx framework reference.
|