跳到主要内容

命令 (CLI)

本部分文档内容向你介绍本项目强大功能之一的 CLI 命令行指令，大部分功能建立在这些底层指令上
你可以随时回来查询不熟悉的命令和选项参数，当你熟练掌握后用起来会非常方便，这是一个不断学习的过程

基础​

核心入口指令为 arcadia，下面是命令帮助菜单，你可以在使用中随时输入 arcadia 查看帮助菜单

$ arcadia
❖ Arcadia CLI

  运行代码相关
  run <args>      执行代码文件（脚本）
  stop <args>     终止运行中的代码程序（脚本）
  list <args>     列出指定目录下可执行的代码文件清单
  ps              查看资源消耗和运行中的代码进程
  cleanup         终止阻塞的代码进程，释放内存

  更新与升级
  update <args>   同步用户配置，更新导入的代码文件
  upgrade         更新项目源码，升级版本

  用户配置管理
  repo <args>     导入代码仓库配置
  raw <args>      导入远程文件配置
  envm <args>     管理环境变量数据

  服务管理
  service <args>  项目后端服务
  tgbot <args>    TG机器人

  其它
  rmlog           清理运行日志文件
  notify <args>   推送自定义通知消息
为了便于用户操作，项目环境设置了一个简短的重定向指令 ad

其中涉及到 <args> 的子命令是需要进一步传入参数而不能单独执行的，具体请看子命令的帮助菜单和其它部分的文档内容
另外在接下来的文档内容和命令帮助菜单中，你会看到很多由括号括起来的内容，这些是需要你自行输入的内容或可选命令

比如：

  • <xxx> 表示需要你自行输入与命令相关的内容，<xxx/xxx> 则表示支持多种类型的内容
  • <args> 表示固定的子命令或传参，分别表示对应命令的不同功能实现
  • [xxx] 表示可选的内容，一般是命令选项，分别对应命令的不同可选功能扩展

方括号和尖括号均作为指导用户输入的提示，不必传入

执行命令的位置​

你需要知道的概念

执行位置区分容器内、容器外这一基础概念性问题，容器外即表示宿主机，由于项目运行在容器内，所以不能直接在宿主机执行相关命令，可通过如下两种方式实现

  • 进入容器内​

    docker exec -it <容器名称/容器ID> bash

    管理面板中的命令行界面就是在容器内操作的

  • 在宿主机调用​

    docker exec -it <容器名称/容器ID> bash <命令>

执行复杂命令建议使用 docker exec -it <容器名称/容器ID> bash -c "<命令>"，多个命令需用 ; 或 && 连接即 "<命令> && <命令>"
后者 && 表示前一条命令执行成功时再执行后一条命令，否则遇到报错会中断，相比前者用法较为特殊