crumbtrail-install-shared 0.2.0 → 0.2.2

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.
Files changed (2) hide show
  1. package/README.md +37 -0
  2. package/package.json +17 -3
package/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # crumbtrail-install-shared
2
+
3
+ Internal building block for [Crumbtrail](https://crumbtrail.dev). It holds the
4
+ install recipes, OTLP facts and agent prompts that the `crumbtrail` CLI and the
5
+ Crumbtrail dashboard both read, so the setup instructions you see in your terminal
6
+ and the ones you see in the browser can't drift apart.
7
+
8
+ **You almost certainly don't need to install this directly.** To set up Crumbtrail
9
+ in your app, run:
10
+
11
+ ```bash
12
+ npx crumbtrail
13
+ ```
14
+
15
+ It's published because both the open-source CLI and the hosted dashboard depend on
16
+ it — not because it's a useful standalone API. It has no stability guarantees.
17
+
18
+ ## What's in it
19
+
20
+ - `getInstallVariant(stack)` / `allStackInstalls()` — which install path a stack takes
21
+ (JS SDK, OTLP, or infrastructure).
22
+ - `buildAgentPrompt(stack, keys)` — the copy-paste prompt handed to a coding agent
23
+ to wire Crumbtrail up.
24
+ - `buildOtlpSnippets(...)` and `OTLP_CAPABILITY_FACTS` — endpoint paths, protocols
25
+ and auth headers for OpenTelemetry exporters. These are kept in lockstep with the
26
+ real ingest routes by a consistency test.
27
+
28
+ ## Links
29
+
30
+ - **Website** — https://crumbtrail.dev
31
+ - **Docs** — https://crumbtrail.dev/docs
32
+ - **Source** — https://github.com/crumbtrail-dev/crumbtrail-js
33
+ - **Issues** — https://github.com/crumbtrail-dev/crumbtrail-js/issues
34
+
35
+ ## License
36
+
37
+ MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "crumbtrail-install-shared",
3
- "version": "0.2.0",
3
+ "version": "0.2.2",
4
4
  "type": "module",
5
5
  "main": "./dist/index.cjs",
6
6
  "module": "./dist/index.js",
@@ -16,14 +16,14 @@
16
16
  "dist"
17
17
  ],
18
18
  "dependencies": {
19
- "crumbtrail-core": "^0.2.0"
19
+ "crumbtrail-core": "^0.2.3"
20
20
  },
21
21
  "devDependencies": {
22
22
  "@types/react": "^19.0.0",
23
23
  "react": "^19.0.0"
24
24
  },
25
25
  "license": "MIT",
26
- "homepage": "https://github.com/crumbtrail-dev/crumbtrail-js/tree/main/packages/install-shared#readme",
26
+ "homepage": "https://crumbtrail.dev",
27
27
  "bugs": {
28
28
  "url": "https://github.com/crumbtrail-dev/crumbtrail-js/issues"
29
29
  },
@@ -35,6 +35,20 @@
35
35
  "publishConfig": {
36
36
  "access": "public"
37
37
  },
38
+ "description": "Shared Crumbtrail install recipes, OTLP facts and agent prompts used by the crumbtrail CLI and dashboard. See https://crumbtrail.dev",
39
+ "keywords": [
40
+ "crumbtrail",
41
+ "debugging",
42
+ "bug-reporting",
43
+ "ai-agents",
44
+ "coding-agent",
45
+ "session-replay",
46
+ "observability",
47
+ "developer-tools",
48
+ "install",
49
+ "recipes",
50
+ "internal"
51
+ ],
38
52
  "scripts": {
39
53
  "build": "tsup",
40
54
  "test": "vitest run",