@stacknext/cli 0.8.0 → 0.10.0

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stacknext/cli",
3
- "version": "0.8.0",
3
+ "version": "0.10.0",
4
4
  "description": "Local-first runtime debugging, diagnostics and Playwright regression testing for Next.js",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -9,7 +9,8 @@
9
9
  },
10
10
  "files": [
11
11
  "dist",
12
- "skills"
12
+ "skills",
13
+ "docs"
13
14
  ],
14
15
  "main": "./dist/index.js",
15
16
  "types": "./dist/index.d.ts",
@@ -22,11 +23,11 @@
22
23
  "./package.json": "./package.json"
23
24
  },
24
25
  "dependencies": {
25
- "@stacknext/core": "0.8.0",
26
- "@stacknext/dashboard": "0.8.0",
27
- "@stacknext/diagnostics": "0.8.0",
28
- "@stacknext/mcp": "0.8.0",
29
- "@stacknext/regression": "0.8.0",
26
+ "@stacknext/core": "0.10.0",
27
+ "@stacknext/dashboard": "0.10.0",
28
+ "@stacknext/diagnostics": "0.10.0",
29
+ "@stacknext/mcp": "0.10.0",
30
+ "@stacknext/regression": "0.10.0",
30
31
  "commander": "14.0.3",
31
32
  "zod": "4.6.7"
32
33
  },
@@ -4,7 +4,7 @@ description: Investigate Next.js App Router runtime behavior with StackNext's lo
4
4
  license: MIT
5
5
  compatibility: Next.js 15 or 16 App Router on the Node.js runtime, with a local StackNext collector. No cloud account, AI API key, or remote service is required.
6
6
  metadata:
7
- version: "0.8.0"
7
+ version: "0.10.0"
8
8
  author: StackNext
9
9
  ---
10
10
 
@@ -77,6 +77,24 @@ run SQL or call an AI service.
77
77
  route/method plus 30-second fallback. Say "correlated" rather than "caused"
78
78
  when the link is fallback-based.
79
79
 
80
+ ## Documentation sources
81
+
82
+ The package API reference lives in the installed npm archives, not in this
83
+ skill. Before using an API, configuration key or command that you are not
84
+ certain about:
85
+
86
+ 1. Read the CLI package's `docs/index.md` and `docs/packages.md`. Resolve it from
87
+ the app directory; in a workspace the CLI may be hoisted to the root.
88
+ 2. Read the docs for every package involved in the task.
89
+ 3. Confirm the version in the package.json next to those docs. Prefer the local
90
+ docs over the website or model memory; they match the installed version.
91
+ 4. If a documented path does not resolve, that package is not available. Do not
92
+ reference it or assume its APIs are available.
93
+
94
+ This skill owns investigation procedure and reasoning rules. Package docs own
95
+ the technical reference. See `references/documentation.md` for discovery,
96
+ version checks and optional-package handling.
97
+
80
98
  ## Tool map
81
99
 
82
100
  | Goal | Tool |
@@ -304,3 +322,4 @@ as current live telemetry.
304
322
  - `references/tools.md` — tool arguments, response shapes and `meta`.
305
323
  - `references/workflows.md` — detailed investigation playbooks and report examples.
306
324
  - `references/setup.md` — install, MCP configuration, skill locations and troubleshooting.
325
+ - `references/documentation.md` — local package docs, version checks and optional packages.
@@ -0,0 +1,69 @@
1
+ # Documentation discovery
2
+
3
+ Package documentation ships inside each installed StackNext npm package. It
4
+ describes the installed version, not the latest website release.
5
+
6
+ ## Read in this order
7
+
8
+ 1. The CLI package's `docs/index.md` — entry point and index. Resolve it from the
9
+ app directory; in a workspace it may be hoisted to the workspace root.
10
+ 2. The CLI package's `docs/packages.md` — package table with versions,
11
+ visibility, roles and relative paths.
12
+ 3. The `docs/index.md` of every package involved in the task.
13
+
14
+ The paths in `packages.md` are relative to the CLI docs directory. Check that a
15
+ directory exists before reading it. Optional packages (`@stacknext/playwright`,
16
+ `@stacknext/drizzle`, `@stacknext/prisma`) may be absent.
17
+
18
+ ## Confirm the version
19
+
20
+ Read the package's own `package.json` next to the docs directory, or ask the
21
+ user to run:
22
+
23
+ ```bash
24
+ node -p "require('@stacknext/next/package.json').version"
25
+ ```
26
+
27
+ If the local docs are missing, do not invent API details. Say which package
28
+ version is installed and use only behavior visible in the installed
29
+ implementation or tests. The website at the project repository is a conceptual
30
+ and cross-package reference; it may describe a newer release.
31
+
32
+ ## What each reference owns
33
+
34
+ <!-- coderabbit-ai-generated:v1 -->
35
+
36
+ <!-- coderabbit-ai-generated-section:v1:288ca3f0efa2b410cf1f3bece0fab59bbb1407b61e1f2e543eda24a9230e58d8 -->
37
+
38
+ <!-- coderabbit-ai-generated:v1 -->
39
+
40
+ <!-- coderabbit-ai-generated-section:v1:a8fa35dd707530ebdf92d07c80b1058c90cff608b5fd3bf71a1c4876289a1632 -->
41
+
42
+ | Need | Read |
43
+ | --- | --- |
44
+ | Configuration, wire types, redaction | `@stacknext/core/docs` |
45
+ | Registration, manual spans, actions | `@stacknext/next/docs` |
46
+ | Diagnostic rules and evidence | `@stacknext/diagnostics/docs` (only when the package ships documentation) |
47
+ | Capture, baseline and comparison formats | `@stacknext/regression/docs` |
48
+ | Fixture and correlation | `@stacknext/playwright/docs` |
49
+ | CLI commands and local index | `@stacknext/cli/docs` |
50
+ | MCP tools, prompts and security | `@stacknext/mcp/docs` (only when the package ships documentation) |
51
+ | Query adapters | `@stacknext/drizzle/docs`, `@stacknext/prisma/docs` |
52
+
53
+ <!-- /coderabbit-ai-generated:v1 -->
54
+
55
+ <!-- /coderabbit-ai-generated:v1 -->
56
+
57
+ The skill owns procedures. The package docs own API details. Do not copy large
58
+ API tables into a report; cite the package and page you used.
59
+
60
+ ## If the project has no local docs
61
+
62
+ Older installations may not include `docs/` in the package archive. Then:
63
+
64
+ 1. Tell the user the installed package lacks local documentation.
65
+ 2. Use `stacknext` CLI help and the installed TypeScript declarations.
66
+ 3. Do not assume an API exists because the website shows it for another
67
+ version.
68
+ 4. Suggest upgrading the packages, or running `stacknext init --agents` after
69
+ upgrading to refresh managed project instructions.
@@ -15,9 +15,15 @@ pnpm exec stacknext dev
15
15
  `dev` starts the collector and the app's own `dev` script, then writes
16
16
  `.stacknext/run.json` with a short-lived bearer token. Leave it running.
17
17
 
18
- If the project is not set up yet, see the repository's
19
- [docs/getting-started.md](../../../docs/getting-started.md). In a source
20
- checkout, run `pnpm install && pnpm build` first.
18
+ If the project is not set up yet:
19
+
20
+ 1. Read the CLI package's `docs/index.md` and the Next.js package's
21
+ `docs/installation.md` for the installed version. Resolve the CLI from the app
22
+ directory; it may be hoisted to the workspace root.
23
+ 2. Run `pnpm exec stacknext init` in the app. Add `--agents` if the user wants a
24
+ managed StackNext block in `AGENTS.md`.
25
+ 3. In a StackNext source checkout, run `pnpm install && pnpm build` first and
26
+ see `docs/getting-started/quickstart.md`.
21
27
 
22
28
  Check the collector and instrumentation:
23
29