@ystemsrx/cfshare

v0.1.7

Published

3 months ago

Safely expose local ports/files via Cloudflare Quick Tunnel

Downloads

0High
0Medium
0Low

ystemsrx

cloudflared cloudflare tunnel file-share

⚡ 快速开始

# 安装
npm install -g @ystemsrx/cfshare

# 作为 Agent Skill 使用（Claude Code、Codex 等）
npx skills add ystemsrx/cfshare

# 暴露本地服务
cfshare expose_port '{"port":3000}'

# 分享文件
cfshare expose_files '{"paths":["./dist"]}'

📖 这是什么？

CFShare 是一个 Node.js 命令行工具，让你能够：

🔗 一键将本地端口暴露为临时公网 HTTPS 链接（https://*.trycloudflare.com）
📁 分享文件/目录——自动起本地静态服务器 + 隧道，对方打开链接即可浏览/下载/预览（支持加密）
🔒 内置安全策略——Token/Basic 认证、速率限制、端口黑名单、排除规则
⏱️ 自动过期清理——TTL 到期自动关闭隧道并删除临时文件

[!NOTE] 无需 Cloudflare 账号。CFShare 使用的是 Cloudflare Quick Tunnel（trycloudflare.com），完全免费、即开即用。

🏗️ 工作原理

flowchart LR
    subgraph LOCAL["你的电脑"]
        A["本地服务 / 文件"]
        B["[可选] 反向代理<br/>(认证 + 限流)"]
        C["cloudflared tunnel"]

        A --> B
        B --> C
    end

    C ==>|Cloudflare Quick Tunnel| D["https://xxx.trycloudflare.com"]
    E["对方浏览器"] --> D

CFShare 在内部完成：路径校验 → 文件复制到临时目录 → 启动只读静态服务器 → 挂载认证/限流反代 → 开启 cloudflared 隧道 → 设置过期回收。你只需告诉它"我要分享什么"，它会帮你完成剩下的工作。

🚀 安装步骤

第一步：安装 `cloudflared`

CFShare 依赖 Cloudflare 的 cloudflared 命令行工具来创建隧道。

brew install cloudflare/cloudflare/cloudflared

curl -fsSL https://pkg.cloudflare.com/cloudflare-main.gpg | sudo tee /usr/share/keyrings/cloudflare-main.gpg >/dev/null
echo "deb [signed-by=/usr/share/keyrings/cloudflare-main.gpg] https://pkg.cloudflare.com/cloudflared $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/cloudflared.list
sudo apt-get update && sudo apt-get install cloudflared

# 在 WSL2 中：
curl -fsSL https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64 -o /usr/local/bin/cloudflared
chmod +x /usr/local/bin/cloudflared

或在 Windows 原生 PowerShell / CMD 中使用 winget：

winget install --id Cloudflare.cloudflared

安装后验证：

cloudflared --version
# 输出类似: cloudflared version 2025.x.x

[!IMPORTANT] 只需安装 cloudflared，不需要运行 cloudflared tunnel login。Quick Tunnel 无需账号认证。

第二步：安装 CFShare

npm install -g @ystemsrx/cfshare

验证安装：

cfshare --version
cfshare env_check

🤖 作为 Agent Skill 使用

CFShare 提供了 Agent Skill，让 AI 编程助手（如 Claude Code、Codex 等）能够自动调用 CFShare 命令。安装 Skill：

npx skills add ystemsrx/cfshare

安装后，直接用自然语言和 AI 助手对话即可：

"把 3000 端口用 token 认证暴露出去"

"把 ./dist 目录通过公网链接分享出去"

"关掉所有正在分享的链接"

Agent 会自动调用相应的 cfshare 命令并返回结果。

🖥️ 使用方法

cfshare <命令> [参数JSON] [选项]

常用示例

# 检查环境与策略
cfshare env_check

# 暴露已有本地服务
cfshare expose_port '{"port":3000,"opts":{"access":"token"}}'

# 分享文件/目录
cfshare expose_files '{"paths":["./dist"],"opts":{"access":"none"}}'

# 列出活跃的分享
cfshare exposure_list

# 停止分享
cfshare exposure_stop '{"id":"all"}'

expose_port 与 expose_files 默认会打印结果并退出。如果你需要以前台方式保持生命周期管理（Ctrl+C 停止），可加 --keep-alive。

选项

⚙️ 配置（可选）

CFShare 开箱即用，以下默认配置适合绝大多数场景。如需调整，通过 --config 或 --config-file 传入：

cfshare expose_port '{"port":3000}' --config '{"defaultTtlSeconds":7200}'

或创建配置文件（如 ~/.cfshare/config.json）：

{
  "cloudflaredPath": "cloudflared",
  "defaultTtlSeconds": 3600,
  "defaultExposePortAccess": "token"
}

cfshare expose_port '{"port":3000}' --config-file ~/.cfshare/config.json

可配置项速查

[!TIP] 认证模式说明：
"token" — 访问链接需要带 Token（适合暴露端口）
"basic" — HTTP Basic 认证（用户名/密码）
"none" — 无认证，任何人都可访问（适合临时分享文件）

🧰 命令一览

🔐 安全设计

❓ 常见问题

不需要。CFShare 使用 Cloudflare Quick Tunnel（trycloudflare.com），完全免费，无需注册账号。

默认 1 小时，可通过配置或每次分享时指定（最长 7 天）。到期后自动销毁。

确认 cloudflared 已安装：cloudflared --version
如果安装位置不在 PATH 中，通过 --config 指定完整路径：

cfshare env_check --config '{"cloudflaredPath":"/usr/local/bin/cloudflared"}'

推荐在 Windows 上通过 WSL2 环境使用 CFShare。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme