sentry-tui 0.1.0 → 0.3.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.
Files changed (2) hide show
  1. package/README.md +32 -9
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -20,17 +20,10 @@ Next: command palette, org/project switcher, and the remaining nav sections.
20
20
 
21
21
  ## Install
22
22
 
23
- Every route below installs the same self-contained binary — no Bun, Node, or
24
- npm needed at runtime.
23
+ npm installs a self-contained binary — no Bun or Node needed at runtime.
25
24
 
26
25
  ```bash
27
- # Homebrew
28
- brew install billyvg/tap/sentry-tui
29
-
30
- # Shell installer → ~/.local/bin (set SENTRY_TUI_INSTALL_DIR to change that)
31
- curl -fsSL https://raw.githubusercontent.com/billyvg/sentry-tui/main/install.sh | bash
32
-
33
- # npm — one-off, or installed globally
26
+ # one-off, or installed globally
34
27
  npx sentry-tui
35
28
  npm install -g sentry-tui
36
29
  ```
@@ -40,9 +33,39 @@ binary arrives as an optional dependency, so you download one binary rather
40
33
  than four. Binaries are also attached to every
41
34
  [release](https://github.com/billyvg/sentry-tui/releases).
42
35
 
36
+ The npm install **keeps itself current**. Launching starts the app
37
+ immediately on the build you already have, and a background process fetches
38
+ anything newer — so a release reaches you without `npm i -g` again, and
39
+ without ever making you wait on a 24MB download. Nothing about starting the
40
+ app touches the network.
41
+
42
+ When a new build has finished downloading, a bold pink **Update** appears in
43
+ the bottom-left corner. Click it or press `U` and the app restarts into it on
44
+ the spot; ignore it and you get the new version next launch either way. The
45
+ app looks again once an hour while it is open, and only ever offers a build it
46
+ has already downloaded.
47
+
48
+ Set `SENTRY_TUI_NO_UPDATE=1` to pin whatever you have; `CI` is treated the same
49
+ way. A binary downloaded by hand from the releases page never updates itself,
50
+ and says so by not offering — replace it the same way you got it.
51
+
43
52
  Supported: macOS and Linux, on arm64 and x64. Windows and musl-based Linux
44
53
  (Alpine) aren't built — run from source there.
45
54
 
55
+ ### Crash reporting
56
+
57
+ sentry-tui reports **its own** crashes to Sentry, which is how bugs that only
58
+ happen on someone else's terminal ever get fixed. What goes: the error and its
59
+ stack, the screen you were on, the Sentry API calls leading up to it, how long
60
+ they took, your OS and terminal details, and — so a report can be followed up —
61
+ the account and organization you're signed in to. It also logs what the app
62
+ did along the way: which screens were opened and how quickly, and which
63
+ requests the server refused. What never goes: your auth token, anything you
64
+ typed into a search box, and the contents of your issues.
65
+
66
+ Set `SENTRY_TUI_NO_TELEMETRY=1` to turn it off. It is also off automatically
67
+ when `CI` is set, and when running from source.
68
+
46
69
  ### From source
47
70
 
48
71
  Running from source needs **Bun ≥ 1.3.0**. OpenTUI reaches its native renderer
package/package.json CHANGED
@@ -11,7 +11,7 @@
11
11
  "url": "https://github.com/billyvg/sentry-tui/issues"
12
12
  },
13
13
  "name": "sentry-tui",
14
- "version": "0.1.0",
14
+ "version": "0.3.0",
15
15
  "keywords": [
16
16
  "sentry",
17
17
  "tui",
@@ -34,6 +34,6 @@
34
34
  "node": ">=18.0.0"
35
35
  },
36
36
  "dependencies": {
37
- "@billyvg/sentry-tui": "0.1.0"
37
+ "@billyvg/sentry-tui": "0.3.0"
38
38
  }
39
39
  }