Files
wwtools/CLAUDE.md
T
Joseph Doherty 32f26272ae Initial commit: Wonderware / System Platform tools and reference
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>
2026-05-03 18:22:20 -04:00

3.4 KiB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

What this repo is

A personal collection of reference material and tools for working with AVEVA / Wonderware System Platform (formerly Invensys / Wonderware): vendor documentation, sample projects, an active CLI codebase, and a SQL exploration of the Galaxy Repository — pulled together for offline reference and for grounding LLM-assisted work on Wonderware integrations.

How docs are organized

This repo is consumed primarily by LLM coding agents. Documentation follows the rules in DOCS-GUIDE.md — read it before adding or restructuring documentation. The short version:

  • This CLAUDE.md is a thin index: it points to tools, not into them.
  • Each tool has its own README.md at its folder root that introduces the tool and routes into its deep docs.
  • Deep documentation (API references, workflows, incident notes) lives inside each tool folder.

When in doubt about where content belongs, default to pushing it deeper. DOCS-GUIDE.md has the full doctrine and the maintenance rules.

Layout

  • aalogcli/.NET Framework 4.8 / x86 CliFx-based CLI that reads System Platform binary logs (*.aaLGX) for LLM-driven debugging, built on the aaOpenSource/aaLog reader library.
  • aot/ — ArchestrA Object Toolkit 2014 v4.0 reference material (dev guide, API reference, sample VS solutions).
  • graccesscli/.NET Framework 4.8 / x86 CliFx-based CLI for automating Galaxy configuration through the ArchestrA GRAccess COM interop.
  • grdb/ — SQL/DDL exploration of the Galaxy Repository SQL database (queries, schema, hierarchy/tag-name translation).
  • histdb/ — LLM-oriented reference for AVEVA Historian retrieval (extension tables, wwXxx time-domain extensions, retrieval modes/options, alarm-event SQL, REST API). Distilled from the official Historian Retrieval Guide.

Tool / resource index

Task Go to
Read System Platform logs (last N records, last N minutes, ranges, incremental) — for LLM debugging aalogcli/README.md
Anything AOT — object/primitive design, attributes, building, debugging, samples, API reference aot/README.md
Automate Galaxy configuration via GRAccess COM (CLI usage, session daemon, mutations, LLM integration) graccesscli/README.md
Galaxy Repository SQL — connect, schema, hierarchy queries, contained-name ↔ tag-name translation grdb/README.md
AVEVA Historian retrieval — SQL via INSQL, wwXxx extensions, retrieval modes/options, alarm/event SQL, REST API histdb/README.md

Maintaining this index

Authoritative rules: DOCS-GUIDE.md. The short version that applies here:

  • A new top-level tool requires a new <tool>/README.md first, then one row in the index above pointing to that README. Do not fan out per-file links at the root.
  • A removed tool deletes its row in the same change.
  • When a tool's internals change, update the tool's own README/deep docs — touch this file only if the task → tool mapping changed.
  • If this file grows past ~150 lines or starts repeating tool-internal facts, refactor downward per DOCS-GUIDE.md.