instruqt/cli

Instruqt CLI 镜像文档

镜像概述

Instruqt CLI 镜像提供预配置的命令行环境，用于高效管理Instruqt交互式学习平台的内容开发。Instruqt是专注于构建沉浸式技术培训环境的平台，而该CLI工具允许开发者在本地完成练习环境的创建、调试和发布全流程，无需依赖Web界面，显著提升内容开发效率。

核心功能与特性

• 本地开发闭环：支持在本地构建、编辑和预览Instruqt练习环境，实时验证配置效果
• 全生命周期管理：通过命令行创建、修改、删除练习项目（Tracks）及场景（Scenarios）
• 内置环境测试：自动检测练习配置合法性，模拟用户操作流程验证环境可用性
• 无缝发布流程：一键将本地开发内容发布至Instruqt平台，无需手动上传
• 版本协作支持：与Git等版本控制系统兼容，便于团队协作和内容版本管理
• 配置迁移工具：支持练习配置的导出/导入，简化备份与团队共享

使用场景与适用范围

• 技术培训开发者：为编程、DevOps、云服务等领域创建交互式实践课程
• 企业培训团队：开发定制化内部培训材料，如新员工入职流程、系统操作指南
• 教育机构：构建沉浸式教学环境，提升技术课程的实践参与度
• 开源社区：为开源项目创建交互式教程，降低用户上手门槛

安装与使用方法

前提条件

• Docker Engine 20.10+
• Instruqt平台账号及API密钥（从instruqt.com账户设置获取）

获取镜像

bash
docker pull instruqt/cli:latest

基础使用流程

1. 登录Instruqt平台

bash
docker run --rm -e INSTRUQT_API_KEY="your_api_key" instruqt/cli login

2. 创建新练习项目

bash
# 在当前目录初始化名为"kubernetes-basics"的练习项目
docker run --rm -v $(pwd):/workspace -w /workspace instruqt/cli track init kubernetes-basics

3. 配置与编辑

项目创建后会生成标准目录结构，包含track.yml（项目配置）、scenarios/（场景目录）等文件，可直接本地编辑。编辑完成后验证配置：

bash
docker run --rm -v $(pwd):/workspace -w /workspace instruqt/cli track validate

4. 本地预览

启动本地预览服务，在浏览器中测试练习流程：

bash
# 映射本地8080端口至容器预览服务
docker run --rm -v $(pwd):/workspace -w /workspace -p 8080:8080 instruqt/cli track preview

访问http://localhost:8080即可预览练习效果。

5. 发布至平台

确认测试无误后发布至Instruqt：

bash
docker run --rm -e INSTRUQT_API_KEY="your_api_key" -v $(pwd):/workspace -w /workspace instruqt/cli track push

配置说明

环境变量配置

Docker Compose配置

创建docker-compose.yml简化重复操作：

yaml
version: '3.8'
services:
  instruqt-cli:
    image: instruqt/cli:latest
    environment:
      - INSTRUQT_API_KEY=${INSTRUQT_API_KEY}  # 建议通过.env文件传入
    volumes:
      - ./tracks:/workspace  # 挂载本地练习项目目录
    working_dir: /workspace
    ports:
      - "8080:8080"  # 预览服务端口映射

使用方式：

bash
# 列出所有练习项目
docker-compose run --rm instruqt-cli track list

# 启动预览服务
docker-compose run --rm instruqt-cli track preview

常用命令速查

注意事项

• API密钥应通过环境变量或安全文件挂载传递，避免硬编码在脚本中
• 本地预览端口默认8080，若冲突可通过-p <本地端口>:8080自定义映射
• 项目配置文件需遵循Instruqt规范，详细语法可参考官方配置文档
• 建议将练习项目纳入Git版本控制，配合track push实现内容迭代管理