Skip to content

快速开始

本指南将帮助您快速安装并使用 TeleScopeX。

系统要求

在开始之前,请确保您的系统满足以下要求:

  • Node.js >= 14.0.0
  • npm >= 6.0.0
  • Chrome 浏览器(用于自动化认证)

安装

全局安装(推荐)

使用 npm 全局安装 TeleScopeX:

bash
npm install -g telescopex

安装完成后,您可以在任何位置使用 telescopextsx 命令。

验证安装

运行以下命令验证安装是否成功:

bash
telescopex --version

如果显示版本号,说明安装成功!

首次使用

1. 导航到您的项目目录

bash
cd your-project

2. 运行 TeleScopeX

bash
telescopex

3. 首次使用流程

当您首次运行 TeleScopeX 时,会经历以下流程:

  1. 自动启动 Chrome - TeleScopeX 会自动启动 Chrome 浏览器(远程调试模式)
  2. 手动登录 - 在打开的 Chrome 窗口中登录到研发云平台
  3. 自动提取凭证 - 登录成功后,TeleScopeX 会自动提取您的用户名和 API Key
  4. 自动 npm 认证 - 使用提取的凭证自动完成 npm login
  5. 保存配置 - 成功的配置会被自动保存

4. 后续使用

配置保存后,再次运行 TeleScopeX 时:

bash
tsx

所有步骤将自动完成,无需任何手动操作!🎉

使用示例

场景一:新项目首次认证

bash
# 1. 进入项目目录
cd my-new-project

# 2. 运行 TeleScopeX
telescopex

# 3. 按照提示在浏览器中登录
# 4. 等待自动完成 npm login
# ✅ 完成!

场景二:已配置项目快速认证

bash
# 1. 进入已配置的项目
cd my-existing-project

# 2. 一键运行
tsx

# ✅ 自动完成所有步骤!

场景三:管理多个项目

TeleScopeX 会为每个项目独立保存配置:

bash
# 项目 A
cd project-a
tsx  # 使用项目 A 的配置

# 项目 B
cd project-b
tsx  # 使用项目 B 的配置

常见问题

Chrome 未自动启动?

确保您已安装 Chrome 浏览器,并且 TeleScopeX 有权限启动应用程序。

凭证提取失败?

  1. 确保您已成功登录到研发云平台
  2. 检查网络连接是否正常
  3. 尝试手动刷新页面后重试

找不到 .npmrc 文件?

TeleScopeX 会自动搜索以下位置:

  • 当前目录
  • apps/dtconnector/.npmrc
  • 其他子目录

确保您的项目中包含 .npmrc 配置文件。

下一步

获得帮助

如果您遇到问题:

  • 📢 提交 Issue
  • 💬 联系 Telefe 团队
  • 📚 查看完整文档

Released under the MIT License.