tunelo 0.0.0-stage → 1.7.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 +101 -2
- package/cli.js +36963 -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.hoandat.com` chuyển tiếp về `localhost` của bạn. Đăng nhập bằng tài khoản hoandat (Google hoặc GitHub qua `auth.hoandat.com`); xem tunnel của tài khoản tại [tunnel.hoandat.com](https://tunnel.hoandat.com).
|
|
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
|
+
### Từ 1.6.x lên 1.7.0
|
|
46
|
+
|
|
47
|
+
- Server mặc định đổi sang `tunnel.hoandat.com`. Cấu hình còn lưu `tunnel.inetdev.io.vn` được tự chuyển sang server mới ở lần chạy đầu.
|
|
48
|
+
- Đăng nhập bằng tài khoản thay cho trang Approve. Token ẩn danh cũ vẫn chạy, nhưng `tunelo whoami` nhắc đăng nhập; chạy `tunelo login` một lần để tunnel của máy gắn với tài khoản.
|
|
49
|
+
|
|
50
|
+
## Sử dụng nhanh
|
|
51
|
+
|
|
52
|
+
### Bước 1 — đăng nhập
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
tunelo login
|
|
56
|
+
# Sign in to Tunelo in your browser:
|
|
57
|
+
# https://auth.hoandat.com/device?user_code=...
|
|
58
|
+
# Confirm the code: ABCD-EFGH
|
|
59
|
+
# Waiting for approval...
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Trình duyệt mở trang của `auth.hoandat.com`: đăng nhập bằng Google hoặc GitHub (đã có phiên thì bỏ qua), kiểm mã trùng với mã trên terminal, rồi bấm cho phép máy này. CLI lưu refresh token vào `~/.tunelo/config.json` (quyền 600) và tự làm mới token khi mở tunnel. Mỗi máy là một thiết bị riêng, xem và đăng xuất từng máy ở [auth.hoandat.com/account](https://auth.hoandat.com/account).
|
|
63
|
+
|
|
64
|
+
Đã đăng nhập rồi thì `tunelo login` báo và dừng (`--force` để làm lại). Máy không có trình duyệt (CI): `tunelo login --legacy-key <token>` hoặc biến `TUNELO_KEY` (token ẩn danh).
|
|
65
|
+
|
|
66
|
+
### Bước 2 — mở tunnel
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
tunelo http 3000
|
|
70
|
+
# => https://<random>.tunnel.hoandat.com → http://localhost:3000
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Nhấn `Ctrl+C` để dừng.
|
|
74
|
+
|
|
75
|
+
Tùy chọn hay dùng:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
tunelo http 3000 -s myapp # subdomain cụ thể → https://myapp.tunnel.hoandat.com
|
|
79
|
+
tunelo http 3000:web 5000:api # nhiều tunnel, mỗi cổng một subdomain
|
|
80
|
+
tunelo http 8080 -a user:pass # bảo vệ tunnel bằng Basic Auth
|
|
81
|
+
tunelo tcp 5432 # tunnel TCP (vd PostgreSQL)
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Các lệnh khác
|
|
85
|
+
|
|
86
|
+
| Lệnh | Việc |
|
|
87
|
+
|------|------|
|
|
88
|
+
| `tunelo whoami` | Máy này đang dùng tài khoản nào (hoặc token ẩn danh) |
|
|
89
|
+
| `tunelo logout` | Thu hồi đăng nhập của máy này và xoá token |
|
|
90
|
+
| `tunelo status` | Liệt kê tunnel đang chạy trên máy |
|
|
91
|
+
| `tunelo kill <pid\|subdomain\|all>` | Dừng tunnel đang chạy |
|
|
92
|
+
| `tunelo link <code>` | Cho Localman thấy tunnel của máy chưa đăng nhập (không cần tài khoản) |
|
|
93
|
+
| `tunelo links` / `tunelo links revoke <id>` | Xem hoặc thu hồi các liên kết của máy |
|
|
94
|
+
| `tunelo mcp` | Chạy MCP server (stdio) để agent AI mở tunnel |
|
|
95
|
+
| `tunelo update [--check]` | Cập nhật lên bản mới nhất |
|
|
96
|
+
| `tunelo config --server <url>` / `--key <token>` / `--show` | Đổi server mặc định, đặt token ẩn danh, xem cấu hình |
|
|
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
|