You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+44-1Lines changed: 44 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -308,6 +308,11 @@ The difference between *a tool you use* and *a tool you own.*
308
308
**Read receipts** — see how many devices have viewed each shared item. Updates live as teammates open the page.
309
309
310
310
**Item management** — add optional titles to label any item for future reference. Edit text items inline without deleting and re-pasting. Pinned items are protected from both manual deletion and auto-cleanup.
311
+
312
+
**Mobile ready** — install as a PWA directly from your browser. Add to Home Screen on iOS or Android for a native app feel without the App Store.
313
+
314
+
**Security hardened** — rate limiting on all write endpoints, magic number file validation, filename sanitisation, and forced download for executable file types.
315
+
311
316
---
312
317
313
318
## Keyboard Shortcuts
@@ -335,10 +340,46 @@ node server/server.js
335
340
336
341
## Use Cases
337
342
338
-
- Moving content between your phone and laptop over WiFi
343
+
- Moving content between your phone and laptop, or just any device over WiFi
339
344
- Sharing API payloads, logs, or screenshots during a sprint
340
345
- A lightweight team clipboard during standups or pair sessions
341
346
- Home lab file sharing without setting up NAS or cloud sync
347
+
- Piping build logs or stack traces from CI or terminal directly into a shared channel
348
+
- Sharing sensitive credentials or config files over LAN without leaving a cloud trail
349
+
350
+
---
351
+
352
+
## Terminal Usage
353
+
354
+
Since Instbyte exposes a simple HTTP API, you can push content directly from your terminal using `curl` — no browser needed.
npm run build 2>&1 | curl -X POST http://192.168.x.x:3000/text \
366
+
-H "Content-Type: application/json" \
367
+
--data-binary @- \
368
+
-H "X-Channel: general" \
369
+
-H "X-Uploader: CI"
370
+
```
371
+
372
+
**Upload a file from the terminal:**
373
+
```bash
374
+
curl -X POST http://192.168.x.x:3000/upload \
375
+
-F "file=@./build.log" \
376
+
-F "channel=general" \
377
+
-F "uploader=terminal"
378
+
```
379
+
380
+
Replace `192.168.x.x:3000` with the URL shown when Instbyte starts. If auth is enabled, add `-b "instbyte_auth=your-token"` to each request.
381
+
382
+
Useful for piping stack traces, build logs, or environment dumps straight into a channel your whole team can see instantly.
342
383
343
384
---
344
385
@@ -352,6 +393,8 @@ Instbyte follows [Semantic Versioning](https://semver.org). See [Releases](https
352
393
353
394
Instbyte is intentionally lightweight and LAN-first. If you want to extend it — CLI tools, themes, integrations — open an issue or submit a pull request.
354
395
396
+
The codebase has a full test suite (184 tests across unit and integration). Run `npm test` before submitting anything. Issues tagged **good first issue** are a good starting point.
0 commit comments