EZ CLI 用户手册
概述
EZ CLI 是一个功能强大的命令行工具，专为云开发环境和在线学习平台设计。它提供了完整的练习管理、考试管理、实例管理和仓库管理功能，让用户能够轻松地进行技术学习和实践。
用户管理
用户管理命令用于处理用户认证和查看用户信息。
用户登录 (ez user login)
用户登录系统。
语法:
ez user login [flags]选项:
-u, --username <username>- 指定用户名-p, --password <password>- 指定密码
描述: 登录到 EZ CLI 系统。如果不提供用户名和密码参数，将使用配置文件中的凭据。如果提供了用户名但没有密码，系统会提示输入密码。成功登录后，认证令牌会保存到配置文件中。
示例:
# 使用配置文件中的凭据登录
ez user login
# 使用指定用户名登录（会提示输入密码）
ez user login -u jack
# 使用指定用户名和密码登录
ez user login -u jack -p mypassword用户信息 (ez user info)
显示当前用户信息。
语法:
ez user info描述: 显示当前已认证用户的详细信息，包括用户ID、用户名、最大实例数量和可用时长等。
示例:
ez user info输出示例:
ID: 12345
Name: john
Max Play instances: 5
Available Minutes: 1440开发环境管理
开发环境 (Devground) 管理命令用于创建和管理开发实例，提供完整的开发环境。
实例管理
创建实例 (ez dg create)
创建新的开发环境实例。
语法:
ez dg create [flags]选项:
-m, --image <image_id>- 镜像ID（必需）-n, --note <note>- 实例备注-r, --region <region>- 区域（默认: gz）-t, --type <type_id>- 实例类型ID（默认: 8）
描述: 创建新的开发环境实例。使用快速创建模式，自动分配子网和IP地址。支持的区域包括 gz（广州）、sh（上海）、bj（北京）。
示例:
# 创建基本开发环境
ez dg create -m ubuntu20.04 -n "我的开发环境"
# 指定区域和实例类型
ez dg create -m ubuntu20.04 -n "测试环境" -r sh -t 16
# 查看可用镜像
ez dg images列出实例 (ez dg ls)
列出所有开发环境实例。
语法:
ez dg ls别名: list, l
描述: 显示当前用户的所有开发环境实例，包括实例ID、名称、备注、规格、镜像、IP地址和状态。
示例:
ez dg ls输出示例:
== My Devgrounds ==
id Name Note Size Image IP State
1 dev-001 开发环境 2C4G ubuntu20.04 10.32.1.10 running
2 test-env 测试环境 4C8G centos7 10.32.1.11 stopped连接管理
SSH 连接 (ez dg ssh)
SSH 连接到开发环境实例。
语法:
ez dg ssh <instance_id>
ez dg ssh -i <instance_id> [flags]选项:
-i, --id <instance_id>- 实例ID（必需）-l, --local- 使用本地IP连接
描述: 通过SSH连接到指定的开发环境实例。系统会自动处理网络配置和负载均衡器设置。
示例:
# 连接到实例ID为1的开发环境
ez dg ssh 1
# 使用标志方式指定实例ID
ez dg ssh -i 1
# 使用本地IP连接（适用于内网环境）
ez dg ssh -i 1 -l密钥生成 (ez dg kengen)
为开发环境实例生成SSH密钥。
语法:
ez dg kengen -i <instance_id> [flags]选项:
-i, --id <instance_id>- 实例ID（必需）-l, --local- 使用本地IP连接
描述: 为指定的开发环境实例生成SSH密钥对，并自动配置SSH客户端，使后续连接更加便捷和安全。
示例:
# 为实例生成SSH密钥
ez dg kengen -i 1
# 生成密钥后可以直接使用SSH别名连接
ssh dg-1资源查询
镜像列表 (ez dg images)
列出可用的镜像。
语法:
ez dg images描述: 显示所有可用于创建开发环境的镜像列表。
示例:
ez dg images区域列表 (ez dg regions)
列出可用的区域。
语法:
ez dg regions描述: 显示所有支持的区域列表，用于创建开发环境时选择部署位置。
示例:
ez dg regions实例类型 (ez dg types)
列出可用的实例类型。
语法:
ez dg types描述: 显示所有可用的实例类型，包括CPU、内存配置信息。
示例:
ez dg types练习环境管理
练习环境 (Playground) 管理命令用于创建和管理练习实例，提供隔离的学习和实验环境。
实例管理
创建实例 (ez pg create)
创建新的练习环境实例。
语法:
ez pg create [flags]选项:
-m, --image <image_id>- 镜像ID（必需）-n, --note <note>- 实例备注-r, --region <region>- 区域（默认: gz）-t, --net <subnet_id>- 子网ID（默认: auto）-y, --type <type_id>- 实例类型ID（默认: 8）
描述: 创建新的练习环境实例。与开发环境不同，练习环境支持手动指定子网，适合更精细的网络配置需求。
示例:
# 创建基本练习环境
ez pg create -m ubuntu20.04 -n "Docker练习环境"
# 指定子网和实例类型
ez pg create -m ubuntu20.04 -n "K8s实验" -t 123 -y 16
# 查看可用子网
ez pg subnets列出实例 (ez pg ls)
列出所有练习环境实例。
语法:
ez pg ls别名: list, l
描述: 显示当前用户的所有练习环境实例，包括实例ID、名称、备注、规格、镜像、IP地址和状态。
示例:
ez pg ls输出示例:
== My Playgrounds ==
id Name Note Size Image IP State
1 pg-001 Docker练习 2C4G ubuntu20.04 10.33.1.10 running
2 k8s-lab K8s实验 4C8G ubuntu20.04 10.33.1.11 stoppedez pg start
启动练习环境实例。
语法:
ez pg start <instance_id>
ez pg start -i <instance_id>选项:
-i, --id <instance_id>- 实例ID
描述: 启动指定的练习环境实例。实例启动后可以通过SSH连接使用。
示例:
# 启动实例ID为1的练习环境
ez pg start 1
# 使用标志方式指定实例ID
ez pg start -i 1ez pg stop
停止练习环境实例。
语法:
ez pg stop <instance_id>
ez pg stop -i <instance_id>选项:
-i, --id <instance_id>- 实例ID
描述: 停止指定的练习环境实例。停止后实例将不再消耗计算资源，但数据会保留。
示例:
# 停止实例ID为1的练习环境
ez pg stop 1
# 使用标志方式指定实例ID
ez pg stop -i 1ez pg rm
删除练习环境实例。
语法:
ez pg rm <instance_id>
ez pg rm -i <instance_id>选项:
-i, --id <instance_id>- 实例ID
描述: 永久删除指定的练习环境实例。删除后实例及其所有数据将无法恢复。
示例:
# 删除实例ID为1的练习环境
ez pg rm 1
# 使用标志方式指定实例ID
ez pg rm -i 1ez pg ssh
SSH 连接到练习环境实例。
语法:
ez pg ssh <instance_id>
ez pg ssh -i <instance_id> [flags]选项:
-i, --id <instance_id>- 实例ID（必需）-l, --local- 使用本地IP连接
描述: 通过SSH连接到指定的练习环境实例。系统会自动处理网络配置和负载均衡器设置。
示例:
# 连接到实例ID为1的练习环境
ez pg ssh 1
# 使用标志方式指定实例ID
ez pg ssh -i 1
# 使用本地IP连接
ez pg ssh -i 1 -lez pg images
列出可用的镜像。
语法:
ez pg images描述: 显示所有可用于创建练习环境的镜像列表。
示例:
ez pg imagesez pg regions
列出可用的区域。
语法:
ez pg regions描述: 显示所有支持的区域列表。
示例:
ez pg regionsez pg types
列出可用的实例类型。
语法:
ez pg types描述: 显示所有可用的实例类型，包括CPU、内存配置信息。
示例:
ez pg typesez pg subnets
列出可用的子网。
语法:
ez pg subnets别名: nets
描述: 显示所有可用的子网列表，用于创建练习环境时选择网络配置。
示例:
ez pg subnetsez pg azs
列出可用区。
语法:
ez pg azs描述: 显示所有可用区列表。
示例:
ez pg azsez pg kengen
为练习环境实例生成SSH密钥。
语法:
ez pg kengen -i <instance_id> [flags]选项:
-i, --id <instance_id>- 实例ID（必需）-l, --local- 使用本地IP连接
描述: 为指定的练习环境实例生成SSH密钥对，并自动配置SSH客户端配置文件。
示例:
# 为实例生成SSH密钥
ez pg kengen -i 1
# 生成密钥后可以直接使用SSH别名连接
ssh pg-1实用工作流程
开发环境工作流程
# 1. 登录系统
ez user login
# 2. 查看用户信息和可用资源
ez user info
# 3. 查看可用镜像和实例类型
ez dg images
ez dg types
# 4. 创建开发环境
ez dg create -m ubuntu20.04 -n "Python开发环境" -t 16
# 5. 查看创建的实例
ez dg ls
# 6. 连接到开发环境
ez dg ssh 1
# 7. 生成SSH密钥以便后续快速连接
ez dg kengen -i 1练习环境工作流程
# 1. 查看可用资源
ez pg images
ez pg subnets
ez pg types
# 2. 创建练习环境
ez pg create -m ubuntu20.04 -n "Docker练习" -t 123
# 3. 启动实例
ez pg start 1
# 4. 连接到练习环境
ez pg ssh 1
# 5. 完成练习后停止实例
ez pg stop 1
# 6. 不再需要时删除实例
ez pg rm 1多环境管理
# 创建不同用途的环境
ez dg create -m ubuntu20.04 -n "后端开发" -r gz
ez dg create -m centos7 -n "运维测试" -r sh
ez pg create -m ubuntu20.04 -n "前端练习" -t auto
# 查看所有环境
ez dg ls
ez pg ls
# 为常用环境生成SSH密钥
ez dg kengen -i 1
ez dg kengen -i 2
ez pg kengen -i 1最佳实践
实例管理
- 合理命名: 使用有意义的备注名称，便于识别不同用途的实例
- 及时停止: 不使用的练习环境及时停止，节约资源
- 定期清理: 删除不再需要的实例，释放配额
- SSH密钥: 为常用实例生成SSH密钥，提高连接效率和安全性
资源优化
- 选择合适的实例类型: 根据实际需求选择CPU和内存配置
- 区域选择: 选择距离较近的区域以获得更好的网络延迟
- 监控使用情况: 定期查看用户信息，了解资源使用状况
安全建议
- 定期更新密码: 定期更新登录密码
- 使用SSH密钥: 优先使用SSH密钥而非密码认证
- 网络配置: 在内网环境中使用
--local参数提高安全性
常见问题
连接问题
问题: SSH连接失败 解决方案:
# 检查实例状态
ez dg ls # 或 ez pg ls
# 确保实例正在运行
ez pg start <instance_id>
# 尝试使用本地IP连接
ez dg ssh -i <instance_id> -l创建失败
问题: 实例创建失败 解决方案:
# 检查可用资源
ez user info
# 验证镜像ID
ez dg images # 或 ez pg images
# 验证区域和实例类型
ez dg regions
ez dg types权限问题
问题: 认证失败 解决方案:
# 重新登录
ez user login
# 检查用户信息
ez user info获取帮助
使用 --help 参数查看任何命令的详细帮助信息：
ez --help # 查看主命令帮助
ez user --help # 查看用户管理帮助
ez dg --help # 查看开发环境帮助
ez pg --help # 查看练习环境帮助
ez dg create --help # 查看具体子命令帮助本手册涵盖了 EZ CLI 的核心功能。如需更多信息，请访问官方文档或联系技术支持。