From 8508268a5803a9628f1515be99543972b71f2f86 Mon Sep 17 00:00:00 2001
From: Timmy <loyangchun@gmail.com>
Date: Tue, 7 Apr 2026 09:38:29 +0800
Subject: [PATCH] Add README.md

---
 README.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1b7fed1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,69 @@
+# CodiMD CLI
+
+CodiMD 的命令列工具 - 讓你可以透過終端機管理 CodiMD 協作筆記。
+
+## 安裝
+
+```bash
+# 從 Git 仓库安裝
+pip install git+http://192.168.42.124:31337/timmy/cli-anything-codimd.git
+
+# 或是複製後手動安裝
+git clone http://192.168.42.124:31337/timmy/cli-anything-codimd.git
+cd cli-anything-codimd/agent-harness
+pip install -e .
+```
+
+## 使用方法
+
+```bash
+# 設定你的 CodiMD 伺服器
+cli-anything-codimd config set server https://your-codimd-server.com
+
+# 登入
+cli-anything-codimd user login
+
+# 查看登入狀態
+cli-anything-codimd user status
+
+# 列出所有筆記
+cli-anything-codimd note list
+
+# 取得筆記內容
+cli-anything-codimd note get <note-id>
+
+# 匯出筆記
+cli-anything-codimd export markdown <note-id> -o note.md
+
+# 建立 REPL 模式
+cli-anything-codimd repl
+```
+
+## 指令
+
+| 指令 | 說明 |
+|------|------|
+| `note list` | 列出所有筆記 |
+| `note get <id>` | 取得筆記內容 |
+| `note create` | 建立新筆記 |
+| `note update <id>` | 更新筆記內容 |
+| `note delete <id>` | 刪除筆記 |
+| `user login` | 登入帳號 |
+| `user logout` | 登出 |
+| `user status` | 查看登入狀態 |
+| `export markdown <id>` | 匯出為 Markdown |
+| `export pdf <id>` | 匯出為 PDF |
+| `export html <id>` | 匯出為 HTML |
+| `revision list <id>` | 查看修訂歷史 |
+
+## JSON 模式
+
+所有指令都支援 `--json` 參數輸出機器可讀格式：
+
+```bash
+cli-anything-codimd --json note list
+```
+
+## 授權
+
+MIT License