@archinsight/cli 3.0.0-snapshot.7 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +50 -12
- package/build/index.js +8033 -5519
- package/package.json +4 -3
package/README.md
CHANGED
|
@@ -11,8 +11,8 @@ It embeds `@insight/language` directly and does not call the web app.
|
|
|
11
11
|
```shell
|
|
12
12
|
archinsight link [project-dir] [--format text|json] [--out file]
|
|
13
13
|
archinsight structure [project-dir] [--format text|json] [--out file]
|
|
14
|
-
archinsight query [project-dir] -c <context> [-s <source>] [-v c1|c2|c3|c4|no-filter] [-q query.aiq] [-f text|json] [-o file]
|
|
15
|
-
archinsight render [project-dir] -c <context> [-s <source>] [-v c1|c2|c3|c4|no-filter] [-q query.aiq] [-f dot|svg|json] [-o file]
|
|
14
|
+
archinsight query [project-dir] -c <context> [-s <source>] [-v c1|c2|c3|c4|deployment|no-filter] [-q query.aiq] [-f text|json] [-o file]
|
|
15
|
+
archinsight render [project-dir] -c <context> [-s <source>] [-v c1|c2|c3|c4|deployment|no-filter] [-q query.aiq] [-f dot|svg|json] [-o file]
|
|
16
16
|
archinsight skill init [project-dir] [--target generic|codex|claude] [--out dir] [--force]
|
|
17
17
|
```
|
|
18
18
|
|
|
@@ -23,14 +23,15 @@ archinsight skill init [project-dir] [--target generic|codex|claude] [--out dir]
|
|
|
23
23
|
- `-c, --context <id>` - context id for query/render.
|
|
24
24
|
- `-s, --source <file>` - selected source file for queries using `$tab`.
|
|
25
25
|
- `--tab <source>` - compatibility alias for `--source`.
|
|
26
|
-
- `-v, --view <name>` - built-in view: `c1`, `c2`, `c3`, `c4`, `no-filter`.
|
|
26
|
+
- `-v, --view <name>` - built-in view: `c1`, `c2`, `c3`, `c4`, `deployment`, `no-filter`.
|
|
27
27
|
- `-q, --query <file>` - custom query file; overrides `--view`; relative paths
|
|
28
28
|
are resolved from `project-dir`.
|
|
29
29
|
- `-f, --format <format>` - command output format.
|
|
30
30
|
- `-o, --out <file>` - write payload output to a file instead of stdout.
|
|
31
31
|
- `-t, --theme <theme>` - render theme; defaults to `light`.
|
|
32
32
|
- `--target <target>` - skill target for `skill init`: `generic`, `codex`, or `claude`.
|
|
33
|
-
- `--force` -
|
|
33
|
+
- `--force` - replace the complete generated skill directory after the new
|
|
34
|
+
package has been generated successfully.
|
|
34
35
|
- `-V, --version` - print version.
|
|
35
36
|
- `-h, --help` - print help.
|
|
36
37
|
|
|
@@ -61,26 +62,43 @@ The generic target writes a runtime-neutral guide:
|
|
|
61
62
|
.archinsight/agent/
|
|
62
63
|
archinsight.md
|
|
63
64
|
references/
|
|
65
|
+
cli.md
|
|
64
66
|
modeling.md
|
|
67
|
+
importing-models.md
|
|
65
68
|
syntax.md
|
|
69
|
+
layered-architecture.md
|
|
66
70
|
c1-context.md
|
|
67
71
|
c2-containers.md
|
|
68
72
|
c3-components.md
|
|
69
|
-
c4-
|
|
73
|
+
c4-code.md
|
|
74
|
+
deployment.md
|
|
70
75
|
scaling.md
|
|
71
76
|
project-structure.md
|
|
72
77
|
core.md
|
|
78
|
+
analysis.md
|
|
73
79
|
queries.md
|
|
74
80
|
query-recipes.md
|
|
75
81
|
validation.md
|
|
76
82
|
.core/
|
|
77
83
|
*.ai
|
|
78
84
|
examples/
|
|
85
|
+
layered-architecture.ai
|
|
79
86
|
c1-context.ai
|
|
80
87
|
c2-containers.ai
|
|
81
88
|
c3-components.ai
|
|
82
|
-
c4-
|
|
83
|
-
|
|
89
|
+
c4-code/
|
|
90
|
+
definitions.ai
|
|
91
|
+
model.ai
|
|
92
|
+
deployment-framework.ai
|
|
93
|
+
deployment-infrastructure.ai
|
|
94
|
+
deployment.ai
|
|
95
|
+
deployment-private-gateway/
|
|
96
|
+
deployment-framework.ai
|
|
97
|
+
source-infra.ai
|
|
98
|
+
source-system.ai
|
|
99
|
+
target-infra.ai
|
|
100
|
+
target-system.ai
|
|
101
|
+
external.ai
|
|
84
102
|
c2-containers.aiq
|
|
85
103
|
builtin-views/
|
|
86
104
|
no-filter.aiq
|
|
@@ -88,6 +106,9 @@ The generic target writes a runtime-neutral guide:
|
|
|
88
106
|
c2.aiq
|
|
89
107
|
c3.aiq
|
|
90
108
|
c4.aiq
|
|
109
|
+
deployment.aiq
|
|
110
|
+
queries/
|
|
111
|
+
deployment-internal-actors.aiq
|
|
91
112
|
```
|
|
92
113
|
|
|
93
114
|
Codex and Claude targets package the same Insight reference directly into the
|
|
@@ -115,15 +136,26 @@ After generating a Codex or Claude skill into the default location, restart the
|
|
|
115
136
|
agent session so the skill is discovered. Pass `--out <dir>` to write the same
|
|
116
137
|
package somewhere else.
|
|
117
138
|
|
|
118
|
-
The guide tells agents to treat `archinsight` as the validation source of truth,
|
|
139
|
+
The guide records the exact CLI version that generated it and tells agents to regenerate the package when that version differs, treat `archinsight` as the validation source of truth,
|
|
119
140
|
avoid guessing Insight syntax from other architecture DSLs, inspect project
|
|
120
141
|
structure before broad edits or imports, read bundled core language sources for
|
|
121
142
|
built-in types/presentations/projections, describe systems layer by layer, and
|
|
122
143
|
write custom `.aiq` diagram queries with the supported Cypher-style subset.
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
144
|
+
Dedicated references cover semantic import from C4-oriented DSLs, diagrams,
|
|
145
|
+
inventories, and prose, plus read-only analysis through structure inspection,
|
|
146
|
+
focused queries, and processing of query JSON when the query subset does not
|
|
147
|
+
provide aggregation or graph traversal.
|
|
148
|
+
For deployment and query changes it requires `query --format json` semantic
|
|
149
|
+
inspection before rendering. The JSON reference distinguishes selected graph
|
|
150
|
+
endpoints, underlying linked edges, and logical projection origins.
|
|
151
|
+
The bundled C4 reference explains the constructorless `CodeElement` extension
|
|
152
|
+
point, project-defined code vocabularies, component containment, and the
|
|
153
|
+
minimal built-in query that selects code elements from the current semantic
|
|
154
|
+
tab.
|
|
155
|
+
The bundled deployment reference explains context-owned profiles with
|
|
156
|
+
`appliesTo: <deployment> from <environment>`, element placement through those
|
|
157
|
+
profiles, and wire-level `uses` restricted to `NetworkConnection` descendants.
|
|
158
|
+
Its examples also cover projection rules for storage and physical network paths.
|
|
127
159
|
|
|
128
160
|
## Output Contract
|
|
129
161
|
|
|
@@ -180,3 +212,9 @@ npm --prefix archinsight-cli run publish:npm
|
|
|
180
212
|
|
|
181
213
|
Before publishing, update the package version in `package.json`, commit the
|
|
182
214
|
change, and make sure the working tree is clean.
|
|
215
|
+
|
|
216
|
+
## License
|
|
217
|
+
|
|
218
|
+
Copyright 2021-2026 Alexey Zaytsev
|
|
219
|
+
|
|
220
|
+
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).
|