Skip to content

aCLI Troubleshooting System User Manual, supporting automatic deployment.

License

Notifications You must be signed in to change notification settings

sangfor/acli_doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

acli_doc

aCLI排障服务命令说明文档,一站式排查解决HCI典型故障


简体中文 | English

快速入门

基于 Docusaurus 构建的 aCLI 命令说明文档站
版权所有 © 2025 Sangfor aCloud
本项目采用 GNU General Public License v3.0 开放源代码


1. 概述

本仓库集中管理 acli 命令体系的全部命令说明文档与官方使用示例等,提供:

  • 命令行使用手册
  • 典型排障案例
  • ...

2. 快速参与

2.1 前置要求

  • Node.js ≥ 18
  • 熟悉 Markdown 语法(文档写作)

2.2 文档修改流程

  1. 定位待改文档
  2. 本地修改并保存

2.3 本地部署及测试

修改并保存完毕后,您可以尝试在本地部署或测试,操作流程如下:

npm install          # 安装项目依赖

# 本次测试
npm run start        # 启动本地开发服务器,带有热重载功能
# 访问 http://localhost:3000 查看实时效果

# 本地部署
npm run generate   # 生成最新的命令列表文档
npm run build      # 构建生产版本的静态网站
npm run serve      # 在本地启动服务器预览构建后的网站

如果是在容器中部署,请在所有npm动作前加上 NODE_OPTIONS='--localstorage-file=/tmp/localstorage'

3. 在线访问

目前官方唯一网站 acli(如无法打开,请检查 DNS/代理,或稍后重试;服务器可能因网络波动暂时不可达。)

4. 开源声明

  • 文档框架基于 Docusaurus(MIT License),特别致谢!
  • 本项目整体以 GPL-3.0 授权,任何二次分发或衍生须遵守 LICENSE 条款。

5. 行为准则

请遵守 CODE_OF_CONDUCT.md ,共同维护友好社区。

6. 更新日志

详见 CHANGELOG.md


About

aCLI Troubleshooting System User Manual, supporting automatic deployment.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors