Wiki.js 命令行工具 v1.4
一个通过 GraphQL API 管理 Wiki.js 的完整命令行工具。
快速开始
# 安装
npm install && npm link
# 配置
cp config/wikijs.example.json ~/.config/wikijs.json
# 使用你的 Wiki.js URL 和 API 令牌编辑此文件
# 测试连接
wikijs health
命令参考
读取操作
| 命令 |
描述 |
wikijs list |
列出所有页面 |
wikijs search "查询" |
搜索页面 |
wikijs get <ID或路径> |
读取页面内容 |
wikijs info <ID或路径> |
显示页面元数据 |
wikijs grep "模式" |
在内容中搜索 |
wikijs tree |
显示页面层级结构 |
写入操作
| 命令 |
描述 |
wikijs create <路径> <标题> |
创建页面 |
wikijs create ... --template 模板名 |
使用模板创建 |
wikijs update <ID> |
更新页面 |
wikijs move <ID> <新路径> |
移动页面 |
wikijs delete <ID> |
删除页面 |
标签管理
| 命令 |
描述 |
wikijs tags |
列出所有标签 |
wikijs tag <ID> add <标签> |
添加标签 |
wikijs tag <ID> remove <标签> |
移除标签 |
备份与恢复
| 命令 |
描述 |
wikijs backup |
创建备份 |
wikijs restore-backup <文件> |
从备份恢复 |
wikijs export <目录> |
导出到文件 |
版本管理
| 命令 |
描述 |
wikijs versions <ID> |
显示历史版本 |
wikijs revert <ID> <版本号> |
恢复到指定版本 |
wikijs diff <ID> |
比较版本差异 |
资源管理
| 命令 |
描述 |
wikijs images |
列出所有资源 |
wikijs upload <文件> |
上传资源 |
wikijs delete-image <ID> |
删除资源 |
批量操作
| 命令 |
描述 |
wikijs bulk-create <文件夹> |
从文件批量创建 |
wikijs bulk-update <文件夹> |
从文件批量更新 |
wikijs sync |
同步到本地 |
wikijs sync --watch |
监视模式同步 |
内容分析
| 命令 |
描述 |
wikijs tree |
页面层级树 |
wikijs check-links |
查找失效链接 |
wikijs stats |
显示统计信息 |
wikijs lint <文件> |
检查 Markdown 文件 |
wikijs lint --id <ID> |
检查 Wiki 页面 |
wikijs orphans |
查找无入链页面 |
wikijs duplicates |
查找相似/重复内容 |
wikijs toc <ID> |
生成目录 |
wikijs validate <ID> |
验证页面内容 |
wikijs validate --all |
验证所有页面 |
wikijs spellcheck <ID> |
拼写检查 |
内容操作
| 命令 |
描述 |
wikijs clone <ID> <路径> |
复制页面 |
wikijs replace "旧文本" "新文本" |
跨页面搜索替换 |
wikijs sitemap |
生成 XML 站点地图 |
交互模式
| 命令 |
描述 |
wikijs shell |
交互式 Shell 模式 |
wikijs watch <ID> |
监视页面变更 |
模板管理
| 命令 |
描述 |
wikijs template list |
列出模板 |
wikijs template show <名称> |
显示模板 |
wikijs template create <名称> |
创建模板 |
wikijs template delete <名称> |
删除模板 |
系统操作
| 命令 |
描述 |
wikijs health |
检查连接状态 |
wikijs cache clear |
清除缓存 |
wikijs completion bash |
Shell 自动补全 |
全局选项
| 选项 |
描述 |
-v, --verbose |
详细输出 |
-d, --debug |
调试输出 |
--no-color |
禁用颜色 |
--rate-limit <毫秒> |
API 请求速率限制 |
常用选项
| 选项 |
描述 |
--format json\|table |
输出格式 |
--limit <数量> |
限制结果数量 |
--force |
跳过确认提示 |
--locale <语言> |
指定语言环境 |
--dry-run |
预览变更 |
使用示例
# 使用模板创建页面
wikijs template create doc --content "# {{title}}\n\n{{date}}"
wikijs create "/docs/api" "API 文档" --template doc
# 在文档部分查找失效链接
wikijs check-links --path "/docs"
# 带速率限制的批量导入
wikijs --rate-limit 500 bulk-create ./pages --path-prefix "/imported"
# 持续同步的监视模式
wikijs sync --output ~/wiki-mirror --watch --interval 60
# 调试 API 问题
wikijs --debug list
# 复制页面
wikijs clone 42 "/docs/new-page" --with-tags
# 查找孤立页面（无入链）
wikijs orphans
# 在整个 Wiki 中搜索替换
wikijs replace "旧术语" "新术语" --path "/docs" --dry-run
# 生成目录
wikijs toc 42 --format markdown
# 查找重复内容
wikijs duplicates --threshold 80
# 为 SEO 生成站点地图
wikijs sitemap --output sitemap.xml
# 交互式 Shell 模式
wikijs shell
# 监视页面变更
wikijs watch "/docs/api" --interval 60
# 对页面进行拼写检查
wikijs spellcheck 42 --lang en --ignore "API,CLI,GraphQL"
# 验证所有页面
wikijs validate --all --format json
集成说明
- 所有命令成功时返回退出码 0，失败时返回 1
- 使用
--format json 获取机器可读的输出
- 删除操作会要求确认，除非使用
--force 选项
--content 字符串中的转义序列（\n、\t）会被解析- 模板支持占位符：
{{title}}、{{path}}、{{date}}