@automaton-labs/aib 0.0.5 → 0.0.7

package/dist/help/json/topics/inspect.graph.md

@@ -1,137 +0,0 @@
-Use graph when the question is about file/module boundaries, not one symbol.
-It builds a reusable map of local import relationships, then lets you focus files inside that map.
-
-Good for:
-- mapping an unfamiliar directory or subsystem
-- seeing which files are hubs, entrypoints, or leaves
-- comparing a few known areas without mapping all src
-- choosing files/entities to inspect next
-- checking module boundaries when ownership is unclear
-
-Use deps for one entity's outgoing dependencies.
-Use usages for real incoming references.
-Use graph for file-level connectivity.
-
-Model:
-build graph: scope + view + save
-query graph: fromFile + focus + output toggles
-
-view controls what enters the saved graph.
-focus only expands details for files already inside it.
-If focus misses a file, rebuild with wider scope or view.
-
-Default view:
-directory scope -> local
-file or multiple scopes -> neighbors
-fromFile -> uses the saved graph
-
-Views:
-local      only files inside scope; best directory map
-neighbors  direct import neighborhood; best file-centered map
-expanded   wider neighborhood; more output
-
-Scope choice:
-scope: "src" creates a broad reusable map for src.
-scope: "src/services" is cheaper for local work.
-scope: [...] compares known areas without mapping all src.
-
-After you understand which graph sections matter, hide the rest with JSON fields or prefs.
-Graph can be noisy; shape it for the current task.
-
-Controls:
-scope, view, from, focus, symbolUsage, edges, hubs, entrypoints, leaves, exclude, save
-
-Specific:
-view         local|neighbors|expanded
-from         reuse saved graph index; from=aib:graph:<name>
-focus        focus a file inside the graph; focus=path
-symbolUsage  show imported symbols on edges; +symbolUsage
-
-edges/hubs/entrypoints/leaves  output section toggles; +name or -name
-
-Run:
-aib inspect --stdin
-
-Input:
-{
-  "op": "graph",
-  "requests": [
-    {
-      "scope": "src/services",
-      "view": "local",
-      "save": "services-graph"
-    },
-    {
-      "fromFile": "aib:graph:services-graph",
-      "focus": ["src/services/users.ts", "src/services/admins.ts"],
-      "symbolUsage": true,
-      "edges": false
-    }
-  ]
-}
-
-Focus saved graph later:
-inspect graph --from-file aib:graph:services-graph --focus src/services/messages.ts --focus src/services/posts.ts --symbol-usage
-
-Inline graph focus can add focus and symbolUsage.
-Inline cannot hide graph sections such as edges/hubs/entrypoints/leaves.
-Use JSON request fields or prefs for section control.
-
-Specialized graph command:
-Run:
-aib inspect graph --stdin
-
-Input:
-{
-  "requests": [
-    {
-      "scope": "src/services",
-      "view": "local",
-      "save": "services-graph"
-    },
-    {
-      "fromFile": "aib:graph:services-graph",
-      "focus": ["src/services/users.ts", "src/services/admins.ts"],
-      "symbolUsage": true,
-      "edges": false
-    }
-  ]
-}
-
-Multiple scopes:
-Run:
-aib inspect --stdin
-
-Input:
-{
-  "op": "graph",
-  "scope": ["src/main/server", "src/services/ws"],
-  "view": "local",
-  "save": "server-ws-graph"
-}
-
-scope accepts one file/dir or an array.
-scopes is accepted as an alias for multiple scopes.
-
-Graph prefs:
-inspect.graph.edges boolean
-inspect.graph.hubs boolean
-inspect.graph.entrypoints boolean
-inspect.graph.leaves boolean
-inspect.graph.symbols boolean
-inspect.graph.symbolUsage boolean
-
-symbolUsage is usually the better first choice when imported names matter.
-
-Example:
-session prefs set inspect.graph.edges false inspect.graph.hubs false inspect.graph.symbolUsage true
-
-Output fields:
-summary       file/edge/package counts
-paths         compact path aliases used in text output
-focus         selected files with imports/importedBy
-hubs          highly connected files
-entrypoints   scoped files imported by nobody in graph
-leaves        scoped files importing nobody in graph
-edges         local file-to-file imports
-saved         reusable aib:graph handle

package/dist/help/json/topics/inspect.imports.md

@@ -1,13 +0,0 @@
-Use imports to inspect static and dynamic imports in a file.
-If there are no dynamic imports, the dynamic imports block is omitted.
-
-Controls:
-file, ranges
-
-Defaults: +ranges
-
-Run:
-aib inspect --stdin
-
-Input:
-imports @svc/service.ts

package/dist/help/json/topics/inspect.md

@@ -1,86 +0,0 @@
-Inspect helps you turn an unknown code area into a small working model.
-
-Use it to understand what exists, how pieces connect, what repeats, where a change can spread, and which exact code should enter context next.
-
-One useful flow:
-map -> focus -> code
-
-map: learn what exists and how it connects
-focus: choose files/entities/usages that matter
-code: fetch exact code needed
-
-Choose inspect operation:
-
-declarations in one file         file
-static/dynamic imports           imports
-public API                       exports
-methods/properties of parent     members
-exact implementation             code
-outgoing deps of one entity      deps
-incoming references/callers      usages
-file/module connectivity         graph
-compact directory layout         tree
-repeated declarations/helpers    duplicates
-local import cycles              cycles
-
-Prefer one batch JSON request for related questions.
-Top-level fields are defaults for every request.
-A request without op uses the top-level op.
-A request without file/scope/target uses the top-level value when applicable.
-Each request may override any default.
-
-Batch example:
-
-Run:
-aib inspect --stdin
-
-Input:
-{
-  "file": "src/service.ts",
-  "requests": [
-    { "op": "file" },
-    { "op": "members", "entity": "Service" },
-    {
-      "op": "code",
-      "entities": [
-        { "parent": "Service", "entities": ["render", "reset"] },
-        "normalize"
-      ],
-      "show": true,
-      "save": "service-focus"
-    },
-    {
-      "op": "usages",
-      "target": "src/service.ts",
-      "entity": "normalize",
-      "scope": "src",
-      "detail": "locations"
-    },
-    {
-      "op": "duplicates",
-      "scope": "src/scripts",
-      "detail": "summary",
-      "limit": 20
-    }
-  ]
-}
-
-Inspect controls:
-
-file        default file for requests
-target      file, dir, or symbol area to analyze
-scope       where to search; JSON scope:string|string[]
-entity      one symbol
-entities    several target symbols; JSON entities:[...]
-parent      class/interface parent for methods/properties
-ranges      include line/range metadata; JSON ranges:boolean; CLI --ranges
-localOnly   show local declarations and reexports without resolving facade API; JSON localOnly:boolean; CLI --local-only
-resolveStar resolve export * through re-exported modules; JSON resolveStar:boolean; CLI --resolve-star
-limit       max items in one page; JSON limit:N; CLI --limit N
-offset      page offset; JSON offset:N; CLI --offset N
-all         return all items; JSON all:boolean; CLI --all
-detail      output level; JSON detail:summary|locations|code; CLI --detail summary|locations|code
-show        include code output; JSON show:boolean; CLI --show
-save        save reusable output; JSON save:"name"; CLI --save name
-exclude     skip names/selectors; JSON exclude:[...]
-kinds       restrict selector kinds; JSON kinds:["f","t"]

package/dist/help/json/topics/inspect.members.md

@@ -1,30 +0,0 @@
-Use members to map a class/interface/object-like symbol without reading its body.
-It shows the internal shape of a parent entity without reading its full body.
-
-Good for:
-- listing member names when the parent entity is known
-- narrowing a large parent entity to relevant members
-- understanding object shape before changing or moving related code
-
-Controls:
-file, entity, entities, ranges, limit, offset, all
-
-Prefs:
-inspect.members.maxItems
-inspect.members.all
-
-Run:
-aib inspect --stdin
-
-Input:
-{
-  "file": "src/service.ts",
-  "op": "members",
-  "limit": 12,
-  "requests": [
-    { "entity": "Service" },
-    { "entities": ["ServiceOptions", "WsOptions"], "all": true }
-  ]
-}
-
-inspect members src/service.ts Service [--limit N] [--offset N] [--all] [--ranges]

package/dist/help/json/topics/inspect.tree.md

@@ -1,22 +0,0 @@
-Use tree to list a compact directory layout.
-It is useful before focused inspect when you know the area but not the exact file.
-
-Controls:
-scope, depth, minDepth, limit, only, exclude, onlyDirs, ned, nec
-
-Specific:
-depth     max nesting depth; depth=N
-minDepth  hide shallower paths; minDepth=N
-onlyDirs  show directories only; +onlyDirs
-only      only matching files/dirs; only=[...]
-exclude   skip matching files/dirs; exclude=[...]
-ned       no-default-exclude; ignore built-in excludes; +ned
-nec       no-config-exclude; ignore aib.json tree excludes; +nec
-
-Run:
-aib inspect --stdin
-
-Input:
-tree src depth=4 +onlyDirs limit=200 +ned +nec
-tree @svc depth=3 only=["**/*.ts"] exclude=["**/*.test.ts","**/* copy.ts"]
-tree src depth=3 only=["src/services/**"] limit=80

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

@@ -1,59 +0,0 @@
-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/topics/modulePlan.md

@@ -1,60 +0,0 @@
-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.
-
-If imports created by modulePlan do not match the repo style, run:
-aib help config-setup.import-rules
-
-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"]
-    }
-  ]
-}
-
-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/topics/move.md

@@ -1,46 +0,0 @@
-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.
-
-If imports created by move do not match the repo style, run:
-aib help config-setup.import-rules
-
-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"]
-}
-
-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/topics/mutation.md

@@ -1,63 +0,0 @@
-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.
-
-If move/modulePlan imports do not match the repo style, run:
-aib help config-setup.import-rules
-
-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/topics/patterns.md

@@ -1,74 +0,0 @@
-To refresh help protocol:
-aib help help-protocol
-
-Use aib before broad file reads when the question is about TS/JS structure, references, dependencies, or focused code.
-Use qr for cross-OS quick reads of text files, logs, JSON, scripts, and line windows.
-It is not a replacement for inspect.
-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.
-
-Config excludes can hide files from tree/graph/sync output.
-
-AIB has four config exclude fields:
-inspect.graph.exclude
-inspect.tree.files.exclude
-inspect.tree.onlyDirs.exclude
-sync.tsconfig.exclude
-
-For all of them, node_modules, .git, dist, build, out, and .tmp are skipped by default.
-
-Important: 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/topics/prefs.md

@@ -1,38 +0,0 @@
-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/topics/qr.md

@@ -1,35 +0,0 @@
-Use qr for cross-OS quick reads of text files: ts, js, cmd, sh, json, log, txt, ndjson, etc.
-Use it for compact line windows and batching.
-qr supports AIB path aliases.
-
-It is not a replacement for inspect.
-Use it as a token-efficient way to read text data when semantic inspect is not needed.
-
-For focused text reads, prefer qr over cat/Get-Content/type, especially when aliases, line windows, or batching help.
-Use shell reads only when piping into shell tooling or qr is unavailable.
-
-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.