crumbtrail 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.
- package/README.md +83 -0
- package/package.json +14 -6
package/README.md
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
# crumbtrail
|
|
2
|
+
|
|
3
|
+
The setup wizard for [Crumbtrail](https://crumbtrail.dev). It finds your app, wires
|
|
4
|
+
in the SDK, and confirms the first event actually arrives — so you don't have to
|
|
5
|
+
read an integration guide to get started.
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx crumbtrail
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
That's the whole install. There's nothing to add to `package.json` first.
|
|
12
|
+
|
|
13
|
+
## What it does
|
|
14
|
+
|
|
15
|
+
Running `npx crumbtrail` walks the full path in one pass:
|
|
16
|
+
|
|
17
|
+
1. **Detects** your stack — Next.js, Vite, React, Vue, Svelte, Express, Hono, Node,
|
|
18
|
+
and non-JS services like Django, Rails, Go and .NET.
|
|
19
|
+
2. **Logs you in** (opens a browser, or use `--no-browser` for a device code).
|
|
20
|
+
3. **Provisions** a project and service, and mints an ingest key.
|
|
21
|
+
4. **Installs** the right SDK package and **injects** the setup code into your entry
|
|
22
|
+
file. This is the only step that writes to your repo, and it always runs last.
|
|
23
|
+
5. **Verifies** the wiring end to end, then waits for your first real event.
|
|
24
|
+
|
|
25
|
+
In a monorepo, run it from the repo root: it scans every workspace and service,
|
|
26
|
+
shows you what it found, and wires the ones you pick.
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
crumbtrail [options] Run the setup wizard (detect → login → wire → verify)
|
|
32
|
+
crumbtrail login Log in and cache a token, nothing else
|
|
33
|
+
crumbtrail logout Delete the cached token
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
| Option | Description |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `--yes`, `-y` | Skip confirmations (required with `--project` in CI) |
|
|
39
|
+
| `--project <id>` | Attach to an existing project instead of creating one |
|
|
40
|
+
| `--only <name>` | Monorepo: wire only this service (repeatable) |
|
|
41
|
+
| `--all` | Monorepo: wire every service it can, no prompts |
|
|
42
|
+
| `--workspace <dir>` | Wire just one package dir instead of the whole repo |
|
|
43
|
+
| `--no-browser` | Use the device-code login flow |
|
|
44
|
+
| `--skip-verify` | Don't wait for the first event |
|
|
45
|
+
| `--endpoint <url>` | Cloud endpoint (else `$CRUMBTRAIL_BASE_URL`, else the default) |
|
|
46
|
+
| `--version`, `-v` | Print the version |
|
|
47
|
+
|
|
48
|
+
### Non-interactive / CI
|
|
49
|
+
|
|
50
|
+
Outside a TTY the wizard refuses to guess. Pass `--yes` and an existing
|
|
51
|
+
`--project <id>`:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx crumbtrail --yes --project prj_1234abcd --only web --skip-verify
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## What it writes
|
|
58
|
+
|
|
59
|
+
Only two kinds of change, both in the package it's wiring:
|
|
60
|
+
|
|
61
|
+
- the SDK import and `Crumbtrail.init(...)` call in your entry file
|
|
62
|
+
- `CRUMBTRAIL_KEY` appended to that package's `.env`
|
|
63
|
+
|
|
64
|
+
It won't touch a package that is already wired, and it never edits libraries or
|
|
65
|
+
config-only packages.
|
|
66
|
+
|
|
67
|
+
## Prefer to wire it by hand?
|
|
68
|
+
|
|
69
|
+
Nothing here is magic — see [`crumbtrail-core`](https://www.npmjs.com/package/crumbtrail-core)
|
|
70
|
+
for the three-line manual setup.
|
|
71
|
+
|
|
72
|
+
## Links
|
|
73
|
+
|
|
74
|
+
- **Website** — https://crumbtrail.dev
|
|
75
|
+
- **Docs** — https://crumbtrail.dev/docs
|
|
76
|
+
- **How it works** — https://crumbtrail.dev/how-it-works
|
|
77
|
+
- **Pricing** — https://crumbtrail.dev/pricing
|
|
78
|
+
- **Source** — https://github.com/crumbtrail-dev/crumbtrail-js
|
|
79
|
+
- **Issues** — https://github.com/crumbtrail-dev/crumbtrail-js/issues
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "crumbtrail",
|
|
3
|
-
"version": "0.2.
|
|
4
|
-
"description": "Crumbtrail
|
|
3
|
+
"version": "0.2.2",
|
|
4
|
+
"description": "Set up Crumbtrail in one command: npx crumbtrail detects your framework, wires in the SDK, and verifies the first event. See https://crumbtrail.dev",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
7
7
|
"type": "git",
|
|
@@ -10,10 +10,18 @@
|
|
|
10
10
|
},
|
|
11
11
|
"keywords": [
|
|
12
12
|
"crumbtrail",
|
|
13
|
+
"debugging",
|
|
14
|
+
"bug-reporting",
|
|
15
|
+
"ai-agents",
|
|
16
|
+
"coding-agent",
|
|
17
|
+
"session-replay",
|
|
18
|
+
"observability",
|
|
19
|
+
"developer-tools",
|
|
13
20
|
"cli",
|
|
14
21
|
"setup",
|
|
15
22
|
"wizard",
|
|
16
|
-
"install"
|
|
23
|
+
"install",
|
|
24
|
+
"codegen"
|
|
17
25
|
],
|
|
18
26
|
"type": "module",
|
|
19
27
|
"main": "./dist/index.cjs",
|
|
@@ -41,10 +49,10 @@
|
|
|
41
49
|
},
|
|
42
50
|
"devDependencies": {
|
|
43
51
|
"@types/node": "^25.5.0",
|
|
44
|
-
"crumbtrail-core": "^0.2.
|
|
45
|
-
"crumbtrail-install-shared": "^0.2.
|
|
52
|
+
"crumbtrail-core": "^0.2.3",
|
|
53
|
+
"crumbtrail-install-shared": "^0.2.2"
|
|
46
54
|
},
|
|
47
|
-
"homepage": "https://
|
|
55
|
+
"homepage": "https://crumbtrail.dev",
|
|
48
56
|
"bugs": {
|
|
49
57
|
"url": "https://github.com/crumbtrail-dev/crumbtrail-js/issues"
|
|
50
58
|
},
|