tunelo 0.0.0-stage → 1.6.2
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 +101 -2
- package/cli.js +2163 -0
- package/cli.js.map +7 -0
- package/package.json +42 -4
package/README.md
CHANGED
|
@@ -1,3 +1,102 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Tunelo CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Expose dịch vụ local ra internet qua HTTPS wildcard subdomain — `https://<tên>.tunnel.inetdev.io.vn` chuyển tiếp về `localhost` của bạn.
|
|
4
|
+
|
|
5
|
+
## Cài đặt
|
|
6
|
+
|
|
7
|
+
Yêu cầu: **Node.js 20+** (kèm npm; hoặc pnpm 9+). Không cần clone repo, không cần cấu hình registry hay token — CLI phát hành công khai trên [npmjs](https://www.npmjs.com/package/tunelo). Lệnh chạy được trên **macOS / Windows / Linux** (cmd, PowerShell, bash, zsh).
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# npm
|
|
11
|
+
npm install -g tunelo
|
|
12
|
+
|
|
13
|
+
# hoặc pnpm (chạy `pnpm setup` 1 lần để có global bin trên PATH)
|
|
14
|
+
pnpm setup && pnpm add -g tunelo
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Kiểm tra:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
tunelo --version
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Cập nhật
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
tunelo update # kiểm tra rồi cài bản mới nhất
|
|
27
|
+
tunelo update --check # chỉ xem có bản mới không, không cài
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Lệnh này tự nhận biết bạn cài bằng npm hay pnpm và gọi đúng trình quản lý. Nếu registry không truy cập được, nó in ra lệnh cài thủ công tương ứng.
|
|
31
|
+
|
|
32
|
+
Tunnel đang chạy vẫn giữ code cũ trong bộ nhớ — khởi động lại để dùng bản mới.
|
|
33
|
+
|
|
34
|
+
### Chuyển từ bản cũ `@dattqh/tunelo` (cài từ GitLab registry)
|
|
35
|
+
|
|
36
|
+
Bản cũ không tự cập nhật sang tên gói mới. Làm một lần: gỡ bản cũ, xóa cấu hình registry cũ, rồi cài lại như trên. Thông tin đăng nhập trong `~/.tunelo/config.json` được giữ nguyên, không cần `tunelo login` lại.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm uninstall -g @dattqh/tunelo # hoặc: pnpm remove -g @dattqh/tunelo
|
|
40
|
+
npm config delete @dattqh:registry
|
|
41
|
+
npm config delete "//gitlabs.inet.vn/api/v4/projects/343/packages/npm/:_authToken"
|
|
42
|
+
npm install -g tunelo
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Sử dụng nhanh
|
|
46
|
+
|
|
47
|
+
### Bước 1 — xác thực thiết bị
|
|
48
|
+
|
|
49
|
+
Chạy `tunelo login` → trình duyệt mở trang hiển thị **thiết bị của bạn** (tên máy) + nút **Approve**. Bấm Approve → trang báo thành công và CLI tự nhận token (lưu `~/.tunelo/config.json`):
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
tunelo login
|
|
53
|
+
# Opening browser to authorize this device...
|
|
54
|
+
# Waiting for approval in the browser... ← bấm "Approve" trên trang
|
|
55
|
+
# ✓ Device authorized & signed in.
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Đăng nhập lại trên cùng máy là **idempotent** — nếu token còn hạn, CLI báo "Already authorized" (dùng `--force` để làm lại). Mỗi máy giữ 1 token; login lại thu hồi token cũ của máy đó.
|
|
59
|
+
|
|
60
|
+
Máy không có trình duyệt (CI/server)? Dùng access token trực tiếp:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
tunelo login --key tunelo_xxxxxxxx
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
> Không có tài khoản/đăng ký — xác thực thiết bị qua trình duyệt là đủ.
|
|
67
|
+
|
|
68
|
+
### Bước 2 — mở tunnel
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
tunelo http 3000
|
|
72
|
+
# => https://<random>.tunnel.inetdev.io.vn → http://localhost:3000
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Nhấn `Ctrl+C` để dừng.
|
|
76
|
+
|
|
77
|
+
Tùy chọn hay dùng:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
tunelo http 3000 -s myapp # subdomain cụ thể → https://myapp.tunnel.inetdev.io.vn
|
|
81
|
+
tunelo http 8080 -a user:pass # bảo vệ tunnel bằng Basic Auth
|
|
82
|
+
tunelo http 3000 5000 # mở nhiều tunnel cùng lúc
|
|
83
|
+
tunelo tcp 5432 # tunnel TCP (vd PostgreSQL)
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Các lệnh khác
|
|
87
|
+
|
|
88
|
+
| Lệnh | Việc |
|
|
89
|
+
|------|------|
|
|
90
|
+
| `tunelo keys list` | Liệt kê API key |
|
|
91
|
+
| `tunelo keys create` | Tạo API key mới |
|
|
92
|
+
| `tunelo keys revoke <keyId>` | Thu hồi API key |
|
|
93
|
+
| `tunelo config --key <key>` | Đặt API key mặc định (thủ công) |
|
|
94
|
+
| `tunelo config --server <url>` | Đổi server mặc định |
|
|
95
|
+
| `tunelo config --show` | Xem cấu hình hiện tại |
|
|
96
|
+
| `tunelo logout` | Xoá API key khỏi config |
|
|
97
|
+
|
|
98
|
+
Thứ tự ưu tiên cấu hình: cờ CLI (`--key`, `--server`) > biến môi trường (`TUNELO_KEY`, `TUNELO_SERVER`) > `~/.tunelo/config.json`.
|
|
99
|
+
|
|
100
|
+
## License
|
|
101
|
+
|
|
102
|
+
MIT
|