@miniaxolotl/burrowctl 0.2.7 → 0.2.8
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 +51 -0
- package/package.json +5 -5
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# burrowctl
|
|
2
|
+
|
|
3
|
+
[CLI client](https://github.com/miniaxolotl/burrow) for the burrow tunnel server. Expose local services to the internet via HTTPS subdomains.
|
|
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
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Create a tunnel
|
|
24
|
+
burrowctl tunnel create --port 3000
|
|
25
|
+
|
|
26
|
+
# Create multiple tunnels
|
|
27
|
+
burrowctl tunnel create --port 3000 --port 8080
|
|
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>
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Configure a custom server
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
burrowctl auth set-server your-server.example.com
|
|
43
|
+
burrowctl auth login <token>
|
|
44
|
+
burrowctl tunnel create --port 3000
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Links
|
|
48
|
+
|
|
49
|
+
- [GitHub Repository](https://github.com/miniaxolotl/burrow)
|
|
50
|
+
- [Package Registry](https://npmjs.com/package/@miniaxolotl/burrowctl)
|
|
51
|
+
- [Server Setup](https://github.com/miniaxolotl/burrow#self-hosting)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@miniaxolotl/burrowctl",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.8",
|
|
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.2.
|
|
23
|
-
"@miniaxolotl/burrowctl-linux-arm64": "0.2.
|
|
24
|
-
"@miniaxolotl/burrowctl-darwin-x64": "0.2.
|
|
25
|
-
"@miniaxolotl/burrowctl-darwin-arm64": "0.2.
|
|
22
|
+
"@miniaxolotl/burrowctl-linux-x64": "0.2.8",
|
|
23
|
+
"@miniaxolotl/burrowctl-linux-arm64": "0.2.8",
|
|
24
|
+
"@miniaxolotl/burrowctl-darwin-x64": "0.2.8",
|
|
25
|
+
"@miniaxolotl/burrowctl-darwin-arm64": "0.2.8"
|
|
26
26
|
}
|
|
27
27
|
}
|