stik-cli - npm Package Compare versions

Comparing version 0.2.3 to 0.3.0

bin/stik-net.js

+#!/usr/bin/env node
+require('../lib/launch')('stik-net');

lib/launch.js

@@ -21,3 +21,6 @@ 'use strict';
 function launch(name) {
-  const override = process.env[`${name.toUpperCase()}_BIN`];
+  // Env override key must be shell-safe: uppercase, non-alphanumerics to '_'
+  // (so `stik-net` -> STIK_NET_BIN, not the unusable STIK-NET_BIN).
+  const envKey = name.toUpperCase().replace(/[^A-Z0-9]/g, '_') + '_BIN';
+  const override = process.env[envKey];
   const bundled = path.join(
@@ -38,3 +41,3 @@ __dirname,
     console.error(
-      'stik ships macOS arm64 and Linux x64/arm64 binaries. On other platforms,'
+      'stik-net ships macOS arm64 and Linux x64/arm64 binaries. On other platforms,'
     );
@@ -45,6 +48,6 @@ console.error(
     console.error(
-      '  go install github.com/adamsjack711-ux/stik-cli/cmd/stik@latest'
+      '  go install github.com/adamsjack711-ux/stik-cli/cmd/stik-net@latest'
     );
     console.error(
-      `then point ${name.toUpperCase()}_BIN at the resulting binary.`
+      `then point ${envKey} at the resulting binary.`
     );
@@ -51,0 +54,0 @@ process.exit(1);

package.json

 {
   "name": "stik-cli",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "Passive network watcher — tells you in plain English what's on your network, and taps you on the shoulder when something new shows up.",
@@ -28,3 +28,3 @@ "keywords": [
   "bin": {
-    "stik": "bin/stik.js"
+    "stik-net": "bin/stik-net.js"
   },
@@ -31,0 +31,0 @@ "files": [

README.md

@@ -22,3 +22,3 @@ # stik
   Its network-card maker is Amazon; it hasn't announced a name.
-  Run `stik devices` to see it, or `stik name` to label it.
+  Run `stik-net devices` to see it, or `stik-net name` to label it.
 ```
@@ -30,10 +30,10 @@
 
-stik is a single Go binary. It uses `libpcap` for capture (bundled on macOS; `libpcap0.8` ships on most Linux desktops).
+stik-net is a single Go binary. It uses `libpcap` for capture (bundled on macOS; `libpcap0.8` ships on most Linux desktops). The npm package is `stik-cli`; the installed command is **`stik-net`** (the bare `stik` name belongs to an unrelated tool).
 
 ```bash
 # npm (macOS arm64, Linux x64/arm64 — ships prebuilt binaries, no toolchain needed)
-npm install -g stik-cli
+npm install -g stik-cli        # installs the `stik-net` command
 
-# from source (needs Go 1.26+ and libpcap headers) — installs a binary named `stik`
-go install github.com/adamsjack711-ux/stik-cli/cmd/stik@latest
+# from source (needs Go 1.26+ and libpcap headers) — installs a binary named `stik-net`
+go install github.com/adamsjack711-ux/stik-cli/cmd/stik-net@latest
 
@@ -47,3 +47,3 @@ # or clone + make
 
-Packet capture requires elevated privileges. On macOS you can grant your user access to the BPF devices once (Wireshark's *ChmodBPF* helper does this) instead of running as root; otherwise run stik with `sudo`.
+Packet capture requires elevated privileges. On macOS you can grant your user access to the BPF devices once (Wireshark's *ChmodBPF* helper does this) instead of running as root; otherwise run stik-net with `sudo`.
 
@@ -57,6 +57,6 @@ ---
 ```
-$ stik
+$ stik-net
 
-👋  Welcome to stik. Let's learn what's on your network.
-Listening passively for 10s — stik only ever listens, it never sends traffic.
+👋  Welcome to stik-net. Let's learn what's on your network.
+Listening passively for 10s — stik-net only ever listens, it never sends traffic.
 
@@ -79,6 +79,6 @@ Found 8 devices on your network. Let's figure out what they are.
 
-After that, `stik` is a one-line glance — and usually boring. **Boring is the feature.**
+After that, `stik-net` is a one-line glance — and usually boring. **Boring is the feature.**
 
 ```
-$ stik
+$ stik-net
 ✓ Everything looks normal. 8 known devices.
@@ -90,3 +90,3 @@ ```
 ```bash
-stik daemon
+stik-net daemon
 ```
@@ -100,12 +100,12 @@
 natural home is a headless box — a Pi, a homelab server — where there's no desktop
-to notify. So `stik daemon` can push the alert to you instead, with `--notify`
+to notify. So `stik-net daemon` can push the alert to you instead, with `--notify`
 (repeatable) or the `STIK_NOTIFY` environment variable:
 
 ```bash
-stik daemon --notify desktop                       # the default
-stik daemon --notify ntfy://ntfy.sh/my-home-alerts # ntfy topic (phone push)
-stik daemon --notify https://hooks.example.com/xyz # webhook: the event as JSON
-stik daemon --notify desktop --notify ntfy://my-home-alerts   # both at once
+stik-net daemon --notify desktop                       # the default
+stik-net daemon --notify ntfy://ntfy.sh/my-home-alerts # ntfy topic (phone push)
+stik-net daemon --notify https://hooks.example.com/xyz # webhook: the event as JSON
+stik-net daemon --notify desktop --notify ntfy://my-home-alerts   # both at once
 
-STIK_NOTIFY="ntfy://my-home-alerts,https://hooks.example.com/xyz" stik daemon
+STIK_NOTIFY="ntfy://my-home-alerts,https://hooks.example.com/xyz" stik-net daemon
 ```
@@ -139,11 +139,11 @@
 |---|---|
-| `stik` | Status: is anything new? (runs the setup wizard on first use) |
-| `stik devices` | List every device in plain terms (`--verbose` for MACs & details) |
-| `stik watch` | Live view; new devices highlight as they appear |
-| `stik daemon` | Background watcher; alerts on a new device or rogue DHCP server (`--notify` for desktop / ntfy / webhook) |
-| `stik name <who>` | Name a device — match by name, hostname, IP, or MAC |
-| `stik forget <who>` | Remove a device from the registry |
+| `stik-net` | Status: is anything new? (runs the setup wizard on first use) |
+| `stik-net devices` | List every device in plain terms (`--verbose` for MACs & details) |
+| `stik-net watch` | Live view; new devices highlight as they appear |
+| `stik-net daemon` | Background watcher; alerts on a new device or rogue DHCP server (`--notify` for desktop / ntfy / webhook) |
+| `stik-net name <who>` | Name a device — match by name, hostname, IP, or MAC |
+| `stik-net forget <who>` | Remove a device from the registry |
 
 ```
-$ stik devices
+$ stik-net devices
 Known (4)
@@ -150,0 +150,0 @@ • my phone (Apple iPhone)

bin/stik.js

-#!/usr/bin/env node
-require('../lib/launch')('stik');

New alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Fixed alerts

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Improved metrics

Total package byte prevSize

27371397

0

Lines of code

56

5.66%

No dependency changes