@automaton-labs/aib 0.0.1

package/dist/help/json/docs/inspect.usages.md

@@ -0,0 +1,61 @@
+# Inspect Usages
+
+Use usages to find who references a file, directory, or entity inside a scope.
+It reports real references, not unused imports or text matches.
+For broad impact checks, target-local usages are hidden automatically when the target is inside a wider scope.
+Use includeTarget only when references inside the target file or directory matter.
+
+Good for:
+- checking impact before changing behavior
+- finding consumers of an entity or module area
+- confirming whether extracted or renamed code still has callers
+- getting caller locations or caller code without broad file scans
+
+Use locations for broad impact checks.
+Use code when usage count is small or caller context matters now.
+
+Controls:
+target, scope, entity, entities, parent, detail, limit, all, save, includeTarget
+
+Specific:
+includeTarget  include references inside the target file/directory; +includeTarget
+
+Prefs:
+inspect.usages.maxLocations
+inspect.usages.maxCodeBlocks
+
+Run:
+aib inspect --stdin
+
+Input:
+{
+  "op": "usages",
+  "target": "src/service.ts",
+  "entities": [
+    "createService",
+    { "parent": "Service", "entities": ["render", "reset"] }
+  ],
+  "scope": ["src/app", "src/tests"],
+  "detail": "locations",
+  "save": "service-usages"
+}
+
+inspect usages src/service.ts createService --scope src --detail locations [--limit N] [--all] [--save name]
+
+Expand saved usages by focusing the reusable usages index:
+inspect usages --from-file aib:usages:service-usages --focus createService --detail code
+
+Use the saved usages handle with --from-file/from to focus or expand the reusable index.
+
+Directory target:
+Run:
+aib inspect --stdin
+
+Input:
+{
+  "op": "usages",
+  "target": "src/shared",
+  "scope": ["src/app", "src/renderer"],
+  "detail": "summary",
+  "save": "shared-usages"
+}

package/dist/help/json/docs/modulePlan.md

@@ -0,0 +1,70 @@
+# Module Plan
+
+Modes: preview/apply or execute.
+Use execute for routine changes.
+Use preview/apply when learning a mutation command or inspecting a large multi-step request before writing files.
+
+If a name is ambiguous, use selectors.
+Run help selectors to refresh selector syntax.
+
+modulePlan is for splitting large files into smaller modules.
+Use it when a large file should be refactored into several target files.
+
+modulePlan orchestrates semantic moves and updates affected references/imports.
+
+Use expectEmpty when your modulePlan intent is to move all declarations out of the source file.
+It does not change the move behavior; it only asks output to report remaining source declarations if any remain.
+Use it only when remaining declarations would mean the split did not match your intent.
+Do not use it for partial extractions.
+
+Plan:
+modulePlan preview --stdin
+modulePlan execute --stdin
+modulePlan apply <planId>
+
+Use preview/apply when you want to inspect the plan before writing files.
+Use execute when you want to preview and apply immediately.
+Use --from with captured input handles when rerunning edited large plans.
+
+Split one large source file into several targets:
+Run:
+aib modulePlan execute --stdin
+
+Input:
+{
+  "sourceFile": "src/large-service.ts",
+  "expectEmpty": true,
+  "modules": [
+    {
+      "target": "src/large-service.types.ts",
+      "entities": ["ServiceOptions", "ServiceMode"]
+    },
+    {
+      "target": "src/large-service.core.ts",
+      "entities": ["LargeService", "createLargeService"]
+    }
+  ]
+}
+
+modulePlan is better than many separate move requests when one large source file should be split into several target files.
+
+Preferred JSON fields:
+sourceFile  file being split
+modules     target groups
+target      output file for one group
+entities    symbols moved into that target
+
+Target files are created when needed.
+The order in the request describes intent; rely on TS/IDE refactors for reference and import updates.
+
+If a large or partial modulePlan request fails, edit the captured input file and rerun with --from.
+For small one-off modulePlan requests, write a corrected request instead.
+
+Latest modulePlan input:
+<session-dir>/inputs/modulePlan/_last.json
+
+Handle:
+aib:input:modulePlan:last
+
+Example:
+modulePlan preview --from aib:input:modulePlan:last

package/dist/help/json/docs/move.md

@@ -0,0 +1,53 @@
+# Move
+
+Modes: preview/apply or execute.
+Use execute for routine changes.
+Use preview/apply when learning a mutation command or inspecting a large multi-step request before writing files.
+
+If a name is ambiguous, use selectors.
+Run help selectors to refresh selector syntax.
+
+Move transfers one or more symbols from one file to another.
+Move is semantic; it moves supported declarations and updates affected imports/references.
+Use it for focused extraction into a single target file.
+For large file splitting across several target files, use modulePlan.
+
+Move to file:
+move toFile preview --stdin
+move toFile execute --stdin
+move toFile apply <previewId>
+
+Use preview/apply when you want to inspect the planned change before writing files.
+Use execute when you want to write immediately.
+Use --from with captured input handles when rerunning edited large requests.
+
+Move several entities into one target:
+Run:
+aib move toFile execute --stdin
+
+Input:
+{
+  "sourceFile": "src/service.ts",
+  "targetFile": "src/service.helpers.ts",
+  "entities": ["oldHelper", "OtherHelper"]
+}
+
+Move creates the target file when needed.
+The target can already exist.
+
+The request means:
+take entities from sourceFile and move them into targetFile.
+
+Use refactor batch when the same workflow needs both rename and move steps.
+
+If a large move request fails, edit the captured input file and rerun with --from.
+For small one-off move requests, write a corrected request instead.
+
+Latest move input:
+<session-dir>/inputs/move/_last.json
+
+Handle:
+aib:input:move:last
+
+Example:
+move toFile preview --from aib:input:move:last

package/dist/help/json/docs/mutation.md

@@ -0,0 +1,62 @@
+# Mutation
+
+Mutation commands change code through TS/IDE refactors.
+Successful mutations update affected references and imports.
+
+After a successful mutation, do not manually patch the same imports unless aib reports a follow-up or checks show a real issue.
+
+AIB mutations are designed to reduce manual checking.
+Your job is to express the intent in DSL.
+AIB's job is to convert that intent into code changes.
+
+Do not read all changed files just because a mutation touched them.
+That defeats the purpose of using AIB for mechanical refactors.
+
+If the command succeeds, the requested mechanical change was applied.
+After failure or partial success, use the output to decide the next request.
+
+When running mutation commands, set the harness timeout to 3 minutes.
+If the harness stops waiting before final output appears, recover with:
+
+aib execution status last
+
+Modes:
+preview  inspect planned edits, then apply by id
+apply    write a previewed change
+execute  write immediately
+
+Use execute for routine rename/move/modulePlan requests.
+
+Use preview/apply when you are learning a mutation command, or when one request contains a large multi-step change that you want to inspect before writing files.
+Typical examples: a huge modulePlan or refactor batch.
+
+preview/apply uses more tool calls and more output tokens.
+preview validates input and planned edits, but writing files can still hit a TS/IDE refactor error.
+execute writes immediately and reports what changed.
+
+If a mutation cannot be completed, aib reports the failed part and the captured input.
+For large or partial requests, edit the captured input and rerun the remaining or changed intent.
+For small requests, write a corrected request instead.
+
+Prefer batch JSON for related mutations.
+One request can describe several related changes.
+aib captures JSON input automatically so large failed or partial requests can be edited and rerun.
+
+When a batch mutation partly fails, split the next request by failure type.
+
+If the failure is wrong input, fix the selector/entity/file and run the corrected remaining intent.
+If TS/IDE cannot apply one part of the batch, do not treat the whole intent as failed.
+Run the next request without the failed part and let aib report any later failures.
+Then decide whether failed parts need smaller requests or manual fallback.
+
+If a large or partial mutation request fails, edit the captured input file and rerun with --from.
+For small one-off requests, write a corrected request instead.
+
+Latest mutation inputs:
+<session-dir>/inputs/rename/_last.json
+<session-dir>/inputs/move/_last.json
+<session-dir>/inputs/refactor/_last.json
+<session-dir>/inputs/modulePlan/_last.json
+
+Example:
+rename preview --from aib:input:rename:last

package/dist/help/json/docs/patterns.md

@@ -0,0 +1,178 @@
+# Working Patterns
+
+Use aib before broad file reads when the question is about TS/JS structure, references, dependencies, or focused code.
+Use normal text search when the question is just text.
+
+For a first pass in a new codebase, map directories before reading files:
+
+tree src depth=5 +onlyDirs limit=200
+
+Start compact for broad scans.
+Use summary, locations, or local graph views first when output could be large.
+Expand to code or wider graph views only for the parts that matter now.
+If output hides data and shows `view: aib:res_<id>`, use `aib view ...` to fetch only the hidden part instead of repeating the original request.
+
+Compact output is a starting point, not a substitute for needed code.
+Fetch exact code when correctness depends on implementation details.
+
+Use prefs when the current phase repeats the same output shape.
+Turn details off when they stop helping.
+Turn them back on when they matter.
+
+Use @file only when several following operations share the same file.
+For independent one-off file requests, pass the path directly:
+file @svc/a.ts
+code @svc/b.ts ServiceB
+
+AIB mutations are designed to reduce manual checking.
+Your job is to express the intent in DSL.
+AIB's job is to convert that intent into code changes.
+
+Do not read all changed files just because a mutation touched them.
+That defeats the purpose of using AIB for mechanical refactors.
+
+If the command succeeds, the requested mechanical change was applied.
+After failure or partial success, use the output to decide the next request.
+
+For mutation commands, set the shell/tool harness timeout to 3 minutes.
+
+If a mutation command times out or returns no final output, use:
+
+aib execution status last
+
+This is an escape hatch for recovering the latest mutation status/result.
+
+Before repeated mutation work, check aib config:
+
+aib config
+
+Set pathAliases for repeated request paths.
+Set importRules so move/modulePlan create imports in the project style.
+
+This avoids repeating long paths in requests and avoids manual import cleanup after mutations.
+Do this before large move/modulePlan work, not after cleanup becomes repetitive.
+
+Example aib.json config:
+
+{
+  "pathAliases": {
+    "svc": "src/services",
+    "cli": "packages/cli/src",
+    "ext": "packages/extension/src"
+  },
+  "importRules": [
+    {
+      "scope": ".",
+      "specifier": "shortest",
+      "ending": "auto",
+      "builtin": "bare",
+      "unusedImports": "remove"
+    }
+  ],
+  "importNormalize": [
+    {
+      "scope": "src",
+      "to": "shortestAlias",
+      "exclude": ["src/generated"]
+    }
+  ],
+  "inspect.graph.exclude": [
+    "**/* copy.ts"
+  ]
+}
+
+pathAliases define short request aliases for paths agents repeat in aib commands.
+Use them to reduce input tokens for repeated inspect and mutation work.
+
+Aliases are for aib request paths. They do not change TypeScript imports by themselves.
+For import style after mutations, use importRules.
+
+importRules control imports created or expanded by move/modulePlan mutation cleanup.
+They do not rewrite the whole project.
+
+AIB starts from IDE/TS import preferences.
+For mutation cleanup, matching importRules in aib.json take priority.
+
+Do not assume IDE/TS defaults match the repo style.
+Set importRules before large move/modulePlan work so imports do not need manual cleanup.
+
+Fields:
+scope      repo-relative file or directory scope; most specific scope wins
+specifier  relative|shortest|project-relative|non-relative
+ending     auto|minimal|index|js
+builtin    node|bare
+unusedImports  remove|preserve
+
+Defaults:
+specifier omitted      IDE/TS decides
+ending omitted         IDE/TS decides
+builtin omitted        keep TS/project builtin style
+unusedImports omitted  keep unused imports
+
+specifier:
+relative          best for local relative imports
+shortest          best for shortest valid alias/path output
+project-relative  best for root-relative project imports
+non-relative      best for package or alias imports
+
+ending:
+minimal  best for extensionless TS imports
+js       best for ESM-style TS projects that require .js
+auto     leaves the decision to TypeScript
+index    best for explicit index import style
+
+builtin:
+node        path -> node:path; best for explicit Node builtin imports
+bare        node:path -> path; best for bare Node builtin imports
+omit field  keeps TypeScript/project output; add builtin if agents keep fixing this manually
+
+unusedImports:
+remove    clean unused imports in mutation-touched files
+preserve  keep unused imports
+omit      same as preserve
+
+Mutation-touched files are files where TS produced edits: source/target files and any reference/update files TS changed.
+Recommended value: remove
+
+importNormalize defines reusable defaults for aib imports normalize.
+Use it when the same normalize request would otherwise be repeated.
+
+It affects explicit import normalize commands only.
+It does not run automatically during move/modulePlan; use importRules for mutation-time cleanup.
+
+Fields:
+scope        repo-relative file or directory scope; most specific scope wins
+to           relative|alias|shortestAlias
+preferAlias  tsconfig paths pattern used when to=alias
+exclude      files, directories, or glob-like patterns to skip
+
+to:
+relative       rewrite resolved local imports to relative paths
+alias          rewrite resolved local imports to a matching tsconfig alias
+shortestAlias  rewrite to the shortest valid alias specifier
+
+preferAlias:
+@shared/*      prefer one alias pattern when several aliases can resolve the same file
+
+inspect.graph.exclude skips files before graph builds the model.
+Use it for generated files, backups, local copies, or other paths that make graph output noisy.
+
+Excluded files do not affect graph counts, hubs, entrypoints, leaves, edges, imports, importedBy, or saved graph files.
+
+Leave feedback while working.
+
+aib is built for agents. Agent feedback is the main signal for improving output, docs, mutations, and token efficiency.
+
+Use feedback when something is wrong, unclear, noisy, or could be more efficient.
+
+Format:
+feedback "kind | message"
+feedback "kind | topic | message"
+
+Kinds:
+bug, confusion, friction, idea, other
+
+Topic is optional. Choose any short topic that helps classify the feedback.
+
+Example:
+feedback "friction | imports | normalize required manual cleanup"

package/dist/help/json/docs/prefs.md

@@ -0,0 +1,40 @@
+# Prefs
+
+Prefs change defaults for the active session.
+Use them when you want repeated CLI behavior without repeating request fields.
+
+Set prefs:
+session prefs set <name> <value> [<name> <value>...]
+
+Example:
+session prefs set inspect.graph.hubs false inspect.graph.leaves false
+
+Show prefs:
+session prefs get [prefix] [--all]
+
+By default, get shows session overrides.
+--all includes defaults.
+prefix filters keys.
+
+boolean = true|false
+N = integer
+
+Available prefs:
+inspect.code.maxNonEmptyLines N
+inspect.usages.maxLocations N
+inspect.usages.maxCodeBlocks N
+inspect.members.maxItems N
+inspect.members.all boolean
+inspect.graph.hubs boolean
+inspect.graph.entrypoints boolean
+inspect.graph.leaves boolean
+inspect.graph.edges boolean
+inspect.graph.symbols boolean
+inspect.graph.symbolUsage boolean
+
+Use prefs to reduce repeated request fields and avoid unnecessary output.
+
+If graph output is too noisy:
+session prefs set inspect.graph.hubs false inspect.graph.leaves false
+
+Change prefs while working. Turn details back on when you need them.

package/dist/help/json/docs/qr.md

@@ -0,0 +1,33 @@
+# Quick Read
+
+Use qr to read arbitrary text files with compact, cross-platform line windows.
+qr supports AIB path aliases.
+
+qr is not a replacement for inspect.
+Use it as a token-efficient way to read text data when semantic inspect is not needed.
+
+Controls:
+-h N    head; first N lines
+-t N    tail; last N lines
+-o N    offset; starting line, 1-based
+-l N    limit; line count for offset reads
+-a      all; whole file
+
+If no window is provided, qr uses -h 80.
+If -a is present, it wins over other window flags.
+
+Run:
+aib qr --stdin
+
+Input:
+qr @scripts/a.txt h=80
+qr @scripts/b.py o=300 l=50
+qr @scripts/c.md t=120
+qr @logs/app.log all
+
+Inline:
+aib qr @scripts/a.txt -h 80
+aib qr @scripts/b.py -o 300 -l 50
+aib qr @logs/app.log -a
+
+Use stdin for several reads.

package/dist/help/json/docs/refactor.batch.md

@@ -0,0 +1,72 @@
+# Refactor Batch
+
+Modes: preview/apply or execute.
+Use execute for routine changes.
+Use preview/apply when learning a mutation command or inspecting a large multi-step request before writing files.
+
+If a name is ambiguous, use selectors.
+Run help selectors to refresh selector syntax.
+
+refactor batch runs related mutation requests together.
+Use it when one workflow needs ordered steps, such as rename plus move.
+
+Use modulePlan when the main intent is only to split one large file into target modules.
+Use refactor batch when the split also includes coordinated renames or mixed mutation steps.
+
+refactor batch preview --stdin
+refactor batch execute --stdin
+refactor batch apply --stdin
+
+Use preview/apply when you want to inspect a large mixed plan before writing files.
+Use execute when you want to write immediately.
+Use --from with captured input handles when rerunning edited large batches.
+
+Example: rename and move in one request
+
+Run:
+aib refactor batch execute --stdin
+
+Input:
+{
+  "sourceFile": "src/service.ts",
+  "requests": [
+    {
+      "op": "rename",
+      "renames": {
+        "oldHelper": "newHelper",
+        "oldType": "newType"
+      }
+    },
+    {
+      "op": "move",
+      "targetFile": "src/service.helpers.ts",
+      "entities": ["newHelper"]
+    },
+    {
+      "op": "move",
+      "targetFile": "src/service.types.ts",
+      "entities": ["newType"]
+    }
+  ]
+}
+
+Use top-level sourceFile when requests operate on the same file.
+Override file/sourceFile inside a request when one request targets another file.
+
+Supported request kinds:
+rename
+move
+
+Use separate command help when the workflow only needs one mutation kind.
+
+If a large or partial refactor batch fails, edit the captured input file and rerun with --from.
+For small one-off refactor requests, write a corrected request instead.
+
+Latest refactor input:
+<session-dir>/inputs/refactor/_last.json
+
+Handle:
+aib:input:refactor:last
+
+Example:
+refactor batch execute --from aib:input:refactor:last

package/dist/help/json/docs/rename.md

@@ -0,0 +1,47 @@
+# Rename
+
+Modes: preview/apply or execute.
+Use execute for routine changes.
+Use preview/apply when learning a mutation command or inspecting a large multi-step request before writing files.
+
+If a name is ambiguous, use selectors.
+Run help selectors to refresh selector syntax.
+
+Rename is for semantic symbol renames.
+It follows TypeScript references.
+It is not plain-text replacement.
+
+Single rename:
+rename preview <file> <entity> <newName>
+rename execute <file> <entity> <newName>
+rename apply <previewId>
+
+Use preview/apply when you want to inspect the planned change before writing files.
+Use execute when you want to write immediately.
+
+Run:
+aib rename execute --stdin
+
+Input:
+{
+  "file": "src/service.ts",
+  "renames": {
+    "oldName": "newName",
+    "OldService": "NewService"
+  }
+}
+
+Rename can use plain names or selectors.
+For methods and properties, prefer JSON so you can pass parent when needed.
+
+If a large rename request fails, edit the captured input file and rerun with --from.
+For small one-off rename requests, write a corrected request instead.
+
+Latest rename input:
+<session-dir>/inputs/rename/_last.json
+
+Handle:
+aib:input:rename:last
+
+Example:
+rename preview --from aib:input:rename:last

package/dist/help/json/docs/selectors.md

@@ -0,0 +1,23 @@
+# Selectors
+
+Selectors identify symbols when names are ambiguous.
+Use plain names when they are unambiguous.
+Use selectors when aib reports ambiguity or when different symbol kinds share a name.
+
+Example:
+type WsOptions
+class WsOptions
+
+If aib needs the exact entity, use:
+t-WsOptions
+c-WsOptions
+
+Selectors list:
+f-name  function
+c-Name  class
+i-Name  interface
+t-Name  type
+v-name  variable
+e-Name  enum
+m-name  method, usually with parent in JSON
+p-name  property, usually with parent in JSON