Update README with admin commands usage

This commit is contained in:
2026-04-07 12:23:42 +08:00
parent b34c503826
commit 1df784ec7c

View File

@@ -41,6 +41,15 @@ cli-anything-codimd repl
## 指令
### 使用者指令
| 指令 | 說明 |
|------|------|
| `user login` | 登入帳號 |
| `user logout` | 登出 |
| `user status` | 查看登入狀態 |
| `user me` | 取得使用者資訊 |
### 筆記指令
| 指令 | 說明 |
|------|------|
| `note list` | 列出所有筆記 |
@@ -48,13 +57,54 @@ cli-anything-codimd repl
| `note create` | 建立新筆記 |
| `note update <id>` | 更新筆記內容 |
| `note delete <id>` | 刪除筆記 |
| `user login` | 登入帳號 |
| `user logout` | 登出 |
| `user status` | 查看登入狀態 |
| `note info <id>` | 取得筆記資訊 |
| `note publish <id>` | 取得發布連結 |
### 匯出指令
| 指令 | 說明 |
|------|------|
| `export markdown <id>` | 匯出為 Markdown |
| `export pdf <id>` | 匯出為 PDF |
| `export html <id>` | 匯出為 HTML |
| `export slide <id>` | 匯出為投影片 |
### 修訂指令
| 指令 | 說明 |
|------|------|
| `revision list <id>` | 查看修訂歷史 |
| `revision get <id> <time>` | 取得特定時間的版本 |
### 管理員指令
需要直接存取 CodiMD 資料庫。
| 指令 | 說明 |
|------|------|
| `admin list-users` | 列出所有使用者 |
| `admin user-notes <id>` | 列出使用者的筆記 |
#### 資料庫使用範例
```bash
# 列出所有使用者SQLite
cli-anything-codimd admin list-users --db-path ./db.sqlite
# 列出所有使用者PostgreSQL
cli-anything-codimd admin list-users --db-type postgresql \
--db-host localhost --db-name codimd --db-user postgres
# 列出所有使用者MySQL
cli-anything-codimd admin list-users --db-type mysql \
--db-host localhost --db-name codimd --db-user root
# 查看特定使用者的筆記
cli-anything-codimd admin user-notes <user-id> --db-path ./db.sqlite
```
### 設定指令
| 指令 | 說明 |
|------|------|
| `config get [key]` | 取得設定值 |
| `config set <key> <value>` | 設定值 |
## JSON 模式
@@ -62,6 +112,7 @@ cli-anything-codimd repl
```bash
cli-anything-codimd --json note list
cli-anything-codimd --json admin list-users --db-path ./db.sqlite
```
## 授權