# Docs

- 文档

  - **介绍**
  - [快速开始](/docs/quick-start): 安装 Arcadia 平台
  - [什么是 Arcadia](/docs): 新一代的代码自动化运维平台
  - [更新日志](/docs/changelog)
  - [关于](/docs/about)

  - **配置**
  - [运行环境](/docs/environment)
  - [环境配置](/docs/configuration)
  - 代码同步
    - [代码同步](/docs/sync)
    - [代码仓库](/docs/sync/repo)
    - [代码文件](/docs/sync/raw)
  - [TG Bot](/docs/tgbot): 在 Telegram 平台上使用 Arcadia，提供一些便捷操作
  - [消息通知](/docs/notify)

  - **使用**
  - [控制面板](/docs/panel)
  - [更新升级](/docs/update)
- Arcadia CLI

  - **介绍**
  - [概述](/docs/cli)

  - **代码文件**
  - 运行代码文件
    - [运行代码文件](/docs/cli/script/run): 运行代码
    - [使用方法](/docs/cli/script/run/main)
    - [终止运行](/docs/cli/script/run/stop)
    - [守护进程](/docs/cli/script/run/daemon)
    - [隔离运行（沙箱）](/docs/cli/script/run/sandbox)
  - [列出代码文件清单](/docs/cli/script/list): 列出指定目录下的代码文件清单
  - [进程管理](/docs/cli/script/process)

  - **更新与升级**
  - [更新代码同步配置](/docs/cli/update/update): 更新或同步导入的代码文件
  - [更新 Arcadia](/docs/cli/update/upgrade): 更新项目源码，升级版本

  - **配置管理**
  - [用户环境变量](/docs/cli/config/envm): 管理环境变量数据
  - [添加代码仓库](/docs/cli/config/repo): 添加代码仓库配置
  - [添加代码文件](/docs/cli/config/raw): 添加代码文件配置

  - **服务管理**
  - [后端服务](/docs/cli/server/service): 后端服务管理
  - [TG Bot](/docs/cli/server/tgbot): Telegram Bot 服务管理

  - **其它**
  - [清理日志](/docs/cli/sundry/rmlog): 删除代码文件的运行日志以及项目产生的各类日志文件
  - [推送通知](/docs/cli/sundry/notify): 推送通知提醒至消息中心
- Arcadia API

  - **介绍**
  - [概述](/docs/api)

  - **接口类别**
  - User 用户
    - [User 用户](/docs/api/user)
    - [登录认证](/docs/api/user/auth)
    - [获取用户信息](/docs/api/user/info)
    - [更改认证信息](/docs/api/user/change-password)
    - [配置双重认证 (2FA)](/docs/api/user/two-factor-auth)
    - [登出所有设备](/docs/api/user/revoke-all-tokens)
  - File 文件系统
    - [File 文件系统](/docs/api/file)
    - [获取文件列表](/docs/api/file/list)
    - [获取文件树](/docs/api/file/tree)
    - [全局文件搜索](/docs/api/file/search)
    - [获取文件内容](/docs/api/file/get-content)
    - [保存文件内容](/docs/api/file/save-content)
    - [删除](/docs/api/file/delete)
    - [查询属性](/docs/api/file/attribute)
    - [创建](/docs/api/file/create)
    - [移动](/docs/api/file/move)
    - [重命名](/docs/api/file/rename)
    - [下载](/docs/api/file/download)
    - [上传文件](/docs/api/file/upload)
  - Cron 定时任务
    - [Cron 定时任务](/docs/api/cron)
    - [数据关系模型](/docs/api/cron/schema)
    - [分页查询](/docs/api/cron/page)
    - [创建](/docs/api/cron/create)
    - [修改](/docs/api/cron/update)
    - [删除](/docs/api/cron/delete)
    - [调整排序](/docs/api/cron/order)
    - [获取标签列表](/docs/api/cron/bind-group)
    - [查询运行中的任务](/docs/api/cron/running-tasks)
    - [运行](/docs/api/cron/run)
    - [终止](/docs/api/cron/terminate)
    - [获取实时日志](/docs/api/cron/live-log)
    - [数据监控](/docs/api/cron/dashboard)
  - Daemon 守护任务
    - [Daemon 守护任务](/docs/api/daemon)
    - [数据关系模型](/docs/api/daemon/schema)
    - [获取列表](/docs/api/daemon/list)
    - [创建与更新](/docs/api/daemon/create)
    - [删除](/docs/api/daemon/delete)
    - [执行操作](/docs/api/daemon/update)
    - [名称检查](/docs/api/daemon/check-name)
    - [日志查看](/docs/api/daemon/log)
    - [日志裁剪](/docs/api/daemon/trim-log)
  - Env 环境变量
    - [Env 环境变量](/docs/api/env)
    - [数据关系模型](/docs/api/env/schema)
    - [分页查询](/docs/api/env/page)
    - [获取所有标签](/docs/api/env/tags)
    - [创建](/docs/api/env/create)
    - [更新插入](/docs/api/env/save)
    - [删除](/docs/api/env/delete)
    - [调整排序](/docs/api/env/order)
    - [更改状态](/docs/api/env/changeStatus)
  - Dependency 依赖管理
    - [Dependency 依赖管理](/docs/api/dependency)
    - [数据关系模型](/docs/api/dependency/schema)
    - [分页查询](/docs/api/dependency/list)
    - [新增](/docs/api/dependency/create)
    - [删除](/docs/api/dependency/delete)
    - [操作](/docs/api/dependency/operate)
    - [查看错误日志](/docs/api/dependency/error)
  - Exec 命令执行
    - [Exec 命令执行](/docs/api/exec)
    - [执行 Shell 命令](/docs/api/exec/cmd)
    - [运行代码文件](/docs/api/exec/file)
    - [获取运行状态](/docs/api/exec/status)
  - Message 消息中心
    - [消息中心](/docs/api/message)
    - [数据关系模型](/docs/api/message/schema)
    - [分页查询](/docs/api/message/list)
    - [获取详情](/docs/api/message/detail)
    - [获取未读消息计数](/docs/api/message/unread-count)
    - [更新已读状态](/docs/api/message/status)
    - [删除](/docs/api/message/delete)
  - Config 配置管理
    - [Config 配置管理](/docs/api/config)
    - [数据关系模型](/docs/api/config/schema)
    - [CLI 配置](/docs/api/config/cli)
    - [系统配置](/docs/api/config/system)
  - Token 令牌管理
    - [Token 令牌管理](/docs/api/token)
    - [权限说明](/docs/api/token/permission)
    - [获取列表](/docs/api/token/list)
    - [创建](/docs/api/token/create)
    - [更新](/docs/api/token/update)
    - [删除](/docs/api/token/delete)
  - Log 系统日志
    - [Log 系统日志](/docs/api/log)
    - [获取操作日志](/docs/api/log/server)
    - [获取登录日志](/docs/api/log/login)
    - [获取开放接口日志](/docs/api/log/openapi)
    - [历史数据清理](/docs/api/log/cleanup)
  - Update 版本更新
    - [版本更新](/docs/api/update)
    - [版本快照](/docs/api/update/snapshot)
    - [检查更新](/docs/api/update/check)
    - [一键更新](/docs/api/update/apply)
  - [Captcha 验证码](/docs/api/captcha)
  - WebSocket
    - [WebSocket](/docs/api/websocket)
    - [代码运行实时日志](/docs/api/websocket/log)
    - [守护任务实时日志](/docs/api/websocket/daemon-log)
    - [定时任务状态推送](/docs/api/websocket/cron-tasks)
    - [依赖管理操作结果](/docs/api/websocket/dependency)
    - [新消息通知](/docs/api/websocket/message)
    - [版本更新状态刷新](/docs/api/websocket/update)
    - [终端](/docs/api/websocket/terminal)
- Arcadia OpenAPI

  - **介绍**
  - [概述](/docs/openapi)

  - **接口类别**
  - File 文件系统
    - [File 文件系统](/docs/openapi/file)
    - [获取文件列表](/docs/openapi/file/v1-list-get)
    - [获取文件内容](/docs/openapi/file/v1-content-get)
    - [保存文件内容](/docs/openapi/file/v1-content-post)
    - [删除](/docs/openapi/file/v1-delete-post)
    - [查询属性](/docs/openapi/file/v1-info-get)
    - [创建](/docs/openapi/file/v1-create-post)
    - [移动](/docs/openapi/file/v1-move-post)
    - [重命名](/docs/openapi/file/v1-rename-post)
    - [下载](/docs/openapi/file/v1-download-get)
    - [上传](/docs/openapi/file/v1-upload-post)
  - Cron 定时任务
    - [Cron 定时任务](/docs/openapi/cron)
    - [分页查询](/docs/openapi/cron/v1-page-get)
    - [查询](/docs/openapi/cron/v1-query-get)
    - [创建](/docs/openapi/cron/v1-create-post)
    - [更新](/docs/openapi/cron/v1-update-post)
    - [删除](/docs/openapi/cron/v1-delete-post)
    - [调整排序](/docs/openapi/cron/v1-order-post)
    - [获取标签列表](/docs/openapi/cron/v1-tagsList-get)
    - [查询运行中的任务](/docs/openapi/cron/v1-runningTasks-get)
    - [运行任务](/docs/openapi/cron/v1-run-post)
    - [终止任务](/docs/openapi/cron/v1-terminate-post)
  - Env 环境变量
    - [Env 环境变量](/docs/openapi/env)
    - [分页查询](/docs/openapi/env/v1-page-get)
    - [全局查询](/docs/openapi/env/v1-query-get)
    - [查询复合变量(组)的成员](/docs/openapi/env/v1-queryMember-get)
    - [精准查询](/docs/openapi/env/v1-queryById-get)
    - [获取所有标签](/docs/openapi/env/v1-tags-get)
    - [创建](/docs/openapi/env/v1-create-post)
    - [更新](/docs/openapi/env/v1-update-post)
    - [更改状态](/docs/openapi/env/v1-changeStatus-post)
    - [调整排序](/docs/openapi/env/v1-order-post)
    - [删除](/docs/openapi/env/v1-delete-post)
  - Exec 命令执行
    - [Exec 命令执行](/docs/openapi/exec)
    - [执行 Shell 命令](/docs/openapi/exec/v1-cmd-post)
    - [执行 Shell 命令（Stream）](/docs/openapi/exec/v1-cmd-stream-post)
    - [运行代码文件](/docs/openapi/exec/v1-file-post)
    - [运行代码文件（Stream）](/docs/openapi/exec/v1-file-stream-post)
    - [终止运行代码文件](/docs/openapi/exec/v1-file-stop-post)
    - [查询运行状态](/docs/openapi/exec/v1-status-get)
  - Message 消息中心
    - [Message 消息中心](/docs/openapi/message)
    - [分页查询](/docs/openapi/message/v1-list-get)
    - [推送消息](/docs/openapi/message/v1-create-post)
    - [获取未读消息计数](/docs/openapi/message/v1-unreadCount-get)
    - [获取消息详情](/docs/openapi/message/v1-detail-get)
    - [更新消息已读状态](/docs/openapi/message/v1-readStatus-post)
    - [更新全部消息已读状态](/docs/openapi/message/v1-readAll-post)
    - [删除消息](/docs/openapi/message/v1-delete-post)