RailWise KB已发布
视频教程：CLI安装与首条命令
RAILWISE-CLI安装与首条命令视频教程配套文档，涵盖安装准备、安装步骤、首条命令执行及常见问题。
learning-path
视频教程：CLI安装与首条命令
Section titled “视频教程：CLI安装与首条命令”| 项目 | 内容 |
|---|---|
| 视频标题 | RAILWISE-CLI 安装与首条命令 |
| 视频时长 | 约15分钟 |
| 难度等级 | ⭐ 入门 |
| 目标观众 | 初次接触CLI的工程师、开发者 |
| 配套版本 | CLI v2.0+ |
完成本视频学习后，您将能够：
- 在本地环境成功安装RAILWISE-CLI
- 执行首条CLI命令并理解输出
- 配置CLI基础环境
- 排查常见安装问题
在开始本视频之前，建议具备以下基础知识：
| 前置知识 | 掌握程度 | 说明 |
|---|---|---|
| 命令行基础 | 了解 | 了解cd、ls、mkdir等基本命令 |
| Node.js/npm | 了解 | 了解Node.js生态和npm包管理 |
| 工程测量概念 | 了解 | 了解坐标系统、测量数据等基本概念 |
步骤1：环境检查（约2分钟）
Section titled “步骤1：环境检查（约2分钟）”操作内容：
- 打开终端（Windows: PowerShell / macOS: Terminal / Linux: Bash）
- 检查Node.js版本：
node --version# 预期输出: v20.x.x 或更高- 检查npm版本：
npm --version# 预期输出: 10.x.x 或更高[截图占位符：终端显示Node.js和npm版本]
CLI要求Node.js 18+。如果版本过低，请前往nodejs.org下载最新LTS版本。
步骤2：安装CLI（约3分钟）
Section titled “步骤2：安装CLI（约3分钟）”操作内容：
- 全局安装RAILWISE-CLI：
npm install -g @railwise/cli- 验证安装：
railwise --version[截图占位符：npm安装过程及版本验证输出]
步骤3：初始化配置（约4分钟）
Section titled “步骤3：初始化配置（约4分钟）”操作内容：
- 创建CLI工作目录：
mkdir ~/railwise-workspacecd ~/railwise-workspace- 初始化CLI配置：
railwise init- 按提示完成配置：
- 选择默认配置模板（推荐）
- 确认数据存储路径
- 设置默认坐标系统（CGCS2000）
[截图占位符：init命令交互过程]
首次初始化会创建以下目录结构：
railwise-workspace/├── config/ # 配置文件├── data/ # 数据存储├── templates/ # 模板文件└── logs/ # 日志文件步骤4：执行首条命令（约4分钟）
Section titled “步骤4：执行首条命令（约4分钟）”操作内容：
- 查看CLI帮助：
railwise --help- 执行首条数据查询命令：
railwise data list --limit 5- 查看命令输出格式：
railwise data list --format json --limit 3[截图占位符：help命令输出及数据查询结果]
步骤5：验证安装（约2分钟）
Section titled “步骤5：验证安装（约2分钟）”操作内容：
- 运行诊断命令：
railwise doctor- 检查输出中的✅标记，确认所有检查项通过
[截图占位符：doctor命令输出，显示所有检查通过]
如果doctor命令显示某些检查失败，请根据提示修复。常见原因：
- 网络连接问题（无法访问API服务器）
- 权限问题（无法写入数据目录）
- 依赖缺失（某些功能需要额外依赖）
关键操作要点
Section titled “关键操作要点”| 要点 | 说明 | 重要性 |
|---|---|---|
| Node.js版本 | 必须18+，推荐20 LTS | ⭐⭐⭐ |
| 全局安装 | 使用 -g 参数全局安装 |
⭐⭐⭐ |
| 初始化配置 | 首次使用必须执行 init |
⭐⭐⭐ |
| doctor诊断 | 安装后运行诊断确认环境 | ⭐⭐ |
| 命令补全 | 善用Tab补全提高效率 | ⭐⭐ |
Q1: 安装失败，提示权限错误
Section titled “Q1: 安装失败，提示权限错误”原因：npm全局安装需要管理员权限
解决：
# macOS/Linuxsudo npm install -g @railwise/cli
# Windows (以管理员身份运行PowerShell)npm install -g @railwise/cliQ2: 安装成功但命令找不到
Section titled “Q2: 安装成功但命令找不到”原因：npm全局目录不在PATH中
解决：
# 查看npm全局目录npm config get prefix
# 将全局目录加入PATHexport PATH="$PATH:$(npm config get prefix)/bin"Q3: 初始化失败，提示目录已存在
Section titled “Q3: 初始化失败，提示目录已存在”原因：目标目录已存在文件
解决：
# 使用 --force 覆盖railwise init --force
# 或选择其他目录railwise init --dir ~/new-workspaceQ4: 数据查询返回空结果
Section titled “Q4: 数据查询返回空结果”原因：本地数据目录为空
解决：
# 导入示例数据railwise data import --sample
# 或连接远程数据源railwise config set api.url https://api.railwise.example.com练习1：环境验证
Section titled “练习1：环境验证”验证您的CLI安装是否完整：
railwise doctor --verbose确认所有检查项显示✅，记录任何⚠️警告信息。
练习2：命令探索
Section titled “练习2：命令探索”探索CLI的所有可用命令：
railwise --helprailwise data --helprailwise project --help记录您发现的最有趣的3个子命令。
练习3：配置自定义
Section titled “练习3：配置自定义”修改CLI配置，设置您的姓名和工作单位：
railwise config set user.name "您的姓名"railwise config set user.org "您的单位"railwise config get user验证配置是否生效。
练习4：数据导入
Section titled “练习4：数据导入”导入示例监测数据并查询：
railwise data import --samplerailwise data list --limit 10railwise data stats观察数据列表和统计输出。