@miniaxolotl/burrowctl 0.2.8 → 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.
- package/README.md +16 -42
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,51 +1,25 @@
|
|
|
1
1
|
# burrowctl
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
## Install
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
npm i -g @miniaxolotl/burrowctl
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Quick start
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
burrowctl auth login <token>
|
|
15
|
-
burrowctl tunnel create --port 3000
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
No account required for the default server (`brmbl.dev`). Your tunnel will be available at `https://<tunnel-id>.brmbl.dev`.
|
|
19
|
-
|
|
20
|
-
## Usage
|
|
3
|
+
Share localhost over HTTPS. No account or manual key setup.
|
|
21
4
|
|
|
22
5
|
```bash
|
|
23
|
-
|
|
24
|
-
burrowctl tunnel
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
burrowctl
|
|
28
|
-
|
|
29
|
-
# List active tunnels
|
|
30
|
-
burrowctl tunnel list
|
|
31
|
-
|
|
32
|
-
# View tunnel logs
|
|
33
|
-
burrowctl tunnel inspect <tunnel-id> --follow
|
|
34
|
-
|
|
35
|
-
# Close a tunnel
|
|
36
|
-
burrowctl tunnel close <tunnel-id>
|
|
6
|
+
npm install -g @miniaxolotl/burrowctl
|
|
7
|
+
burrowctl tunnel 3000 8080
|
|
8
|
+
burrowctl list
|
|
9
|
+
burrowctl logs <id> --follow
|
|
10
|
+
burrowctl close <id>
|
|
37
11
|
```
|
|
38
12
|
|
|
39
|
-
|
|
13
|
+
Connects to `brmbl.dev` by default. Use `--server your-server.example.com` for a
|
|
14
|
+
custom server. The CLI generates a private, per-server owner credential and
|
|
15
|
+
stores it under `~/.config/burrow/owners/`. Only that credential can list/count,
|
|
16
|
+
inspect, reconnect, or close its tunnels. There are no privileged users.
|
|
40
17
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
burrowctl auth login <token>
|
|
44
|
-
burrowctl tunnel create --port 3000
|
|
45
|
-
```
|
|
18
|
+
Shared tunnel URLs expose your local application publicly; use the application's
|
|
19
|
+
authentication when access should be restricted.
|
|
46
20
|
|
|
47
|
-
|
|
21
|
+
Supports Linux and macOS on x64 and ARM64.
|
|
48
22
|
|
|
49
|
-
- [
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
23
|
+
- [Client reference](https://github.com/miniaxolotl/burrow/blob/production/documentation/client.md)
|
|
24
|
+
- [Server setup](https://github.com/miniaxolotl/burrow/blob/production/documentation/server.md)
|
|
25
|
+
- [Source](https://github.com/miniaxolotl/burrow)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@miniaxolotl/burrowctl",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "CLI client for the burrow tunnel server",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
"arm64"
|
|
20
20
|
],
|
|
21
21
|
"optionalDependencies": {
|
|
22
|
-
"@miniaxolotl/burrowctl-linux-x64": "0.
|
|
23
|
-
"@miniaxolotl/burrowctl-linux-arm64": "0.
|
|
24
|
-
"@miniaxolotl/burrowctl-darwin-x64": "0.
|
|
25
|
-
"@miniaxolotl/burrowctl-darwin-arm64": "0.
|
|
22
|
+
"@miniaxolotl/burrowctl-linux-x64": "0.3.0",
|
|
23
|
+
"@miniaxolotl/burrowctl-linux-arm64": "0.3.0",
|
|
24
|
+
"@miniaxolotl/burrowctl-darwin-x64": "0.3.0",
|
|
25
|
+
"@miniaxolotl/burrowctl-darwin-arm64": "0.3.0"
|
|
26
26
|
}
|
|
27
27
|
}
|