supbuddy 3.0.1
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 +62 -0
- package/dist/bin.js +28731 -0
- package/package.json +59 -0
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# supbuddy
|
|
2
|
+
|
|
3
|
+
Run multiple Supabase projects at once on custom local domains with HTTPS. The
|
|
4
|
+
headless CLI and daemon for [Supbuddy](https://supbuddy.app): a Caddy proxy,
|
|
5
|
+
local DNS, Supabase and Docker Compose lifecycle, and an MCP server for AI
|
|
6
|
+
agents. Works on macOS and Linux.
|
|
7
|
+
|
|
8
|
+
`supabase start` only runs one project at a time and collides on ports 54321/2/3.
|
|
9
|
+
Supbuddy keeps every project's full stack running at once, each reachable on its
|
|
10
|
+
own domain like `api.acme.local`.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx supbuddy@latest
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
That prompts to install the CLI globally (the `supbuddy` command, with `sup` as a
|
|
19
|
+
short alias). The CLI is independent of the desktop app, so you can install the
|
|
20
|
+
app later, or not at all. To install without the prompt:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npm install -g supbuddy
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
supbuddy daemon --detach # start the background daemon (proxy, DNS, MCP)
|
|
30
|
+
supbuddy status # daemon + proxy health
|
|
31
|
+
supbuddy project ls # registered projects
|
|
32
|
+
supbuddy supabase start acme --follow # start a project's Supabase, stream progress
|
|
33
|
+
supbuddy map ls # domain → port mappings
|
|
34
|
+
supbuddy mcp add claude-code # register Supbuddy with an AI coding agent
|
|
35
|
+
supbuddy tui # full-screen dashboard (alias: sup dash)
|
|
36
|
+
supbuddy help # the full command reference
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Commands attach to the daemon over a local control port, discovered through a
|
|
40
|
+
`0600` `daemon.json`, so you never pass ports or tokens by hand. Add `--json` to
|
|
41
|
+
any command for machine-readable output.
|
|
42
|
+
|
|
43
|
+
Run on login:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
supbuddy service install # launchd on macOS, systemd-user on Linux
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## The desktop app
|
|
50
|
+
|
|
51
|
+
The macOS desktop app ships the same daemon with a GUI, the local Certificate
|
|
52
|
+
Authority installer, and a request monitor. The CLI and the app share one state
|
|
53
|
+
directory and the same daemon, so they manage the same projects. Get the app at
|
|
54
|
+
[supbuddy.app](https://supbuddy.app).
|
|
55
|
+
|
|
56
|
+
## Docs
|
|
57
|
+
|
|
58
|
+
Full documentation: [supbuddy.app/docs](https://supbuddy.app/docs).
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
MIT
|