| 1 | # brt — Brew Remote Tools |
| 2 | |
| 3 | A Swiss-army CLI for networking, editing, command chains, and secure remote terminal access. |
| 4 | |
| 5 | ## Install |
| 6 | |
| 7 | The site and `brt -help` / `brtwin -help` detect your OS and show the matching one-liner. |
| 8 | |
| 9 | ### macOS / Linux |
| 10 | |
| 11 | ```bash |
| 12 | curl -fsSL https://brt.sushii.dev/install.sh | sh |
| 13 | ``` |
| 14 | |
| 15 | ### Windows |
| 16 | |
| 17 | ```powershell |
| 18 | irm https://brt.sushii.dev/win/install.ps1 | iex |
| 19 | ``` |
| 20 | |
| 21 | On Windows the command is **`brtwin`** (not `brt`). Remote access works across platforms — Mac `brt -access connect` to Windows `brtwin -access serve` and vice versa. |
| 22 | |
| 23 | The install script fetches CLI files from `https://brt.sushii.dev/`. |
| 24 | |
| 25 | ## Quick start |
| 26 | |
| 27 | ```bash |
| 28 | brt -help |
| 29 | brt -ip check |
| 30 | brt -dns google.com |
| 31 | brt -run 'echo "hello";wait 2;echo "bye"' |
| 32 | brt -access serve |
| 33 | ``` |
| 34 | |
| 35 | ## Website & distribution |
| 36 | |
| 37 | The Next.js site in `website/` hosts the docs, wiki, and all installable files under `website/public/`: |
| 38 | |
| 39 | ```bash |
| 40 | cd website && npm install && npm run dev |
| 41 | ``` |
| 42 | |
| 43 | `npm run sync` copies the CLI into `website/public/` before dev/build so these URLs work: |
| 44 | |
| 45 | - `https://brt.sushii.dev/install.sh` |
| 46 | - `https://brt.sushii.dev/brt` |
| 47 | - `https://brt.sushii.dev/lib/*` |
| 48 | - `https://brt.sushii.dev/win/install.ps1` (Windows) |
| 49 | - `https://brt.sushii.dev/win/*` |
| 50 | |
| 51 | ## License |
| 52 | |
| 53 | MIT |
| 54 | |