前言 有時候想用一個簡潔點兒的備忘錄,發現沒有簡潔好用的,於是就想著開發一個,秉著簡潔 的思想,所以連界面都沒有,只能通過命令行來操作(儘可能的將命令簡化)。設計的時候 借鑒了git分支的思想,每個備忘錄都等同於一個分支,我們可以創建多個備忘錄。功能上 可以查看所有備忘錄的名稱,切換備忘錄,添加備忘 ...
前言
有時候想用一個簡潔點兒的備忘錄,發現沒有簡潔好用的,於是就想著開發一個,秉著簡潔
的思想,所以連界面都沒有,只能通過命令行來操作(儘可能的將命令簡化)。設計的時候
借鑒了git分支的思想,每個備忘錄都等同於一個分支,我們可以創建多個備忘錄。功能上
可以查看所有備忘錄的名稱,切換備忘錄,添加備忘內容,“已完成”備忘錄內容,刪除備忘
錄,刪除備忘錄內容。
備忘錄相關的數據文件是放在當前用戶的家目錄裡面的,有個隱藏的文件夾~/.memo/
,這裡面
包含了所有的備忘錄信息。
實現是通過PHP實現的,安裝需要通過composer
安裝,安裝完成之後就可以使用memo xxx
命令
來管理你的備忘錄了。
使用介紹
win下麵目前支持的不是很好
這裡面的所有備忘錄、以及備忘錄中的備忘都有一個短名稱shortName
,截取對應中文名
md5的前幾位,以便於對其進行操作(比如,切換備忘錄、刪除備忘錄、完成備忘等),避免
直接對冗長名稱、數據操作,這也借鑒了git的提交版本。
安裝
這個可以通過composer
安裝在全局,再將bin/
目錄加入到PATH
中,就可以直接使用了:
composer global require aizuyan/cli-memo
上面這個命令會包安裝到~/.composer/
目錄下麵,再將/Users/ruitao/.composer/vendor/bin
路徑配置到系統路徑PATH
中就可以直接使用memo
命令了:
linux下麵我是配置在~/.bashrc
裡面的:
PATH=$PATH:/usr/local/bin:/Users/ruitao/.composer/vendor/bin
memo help
memo help
,這個命令展示了memo的所有命令列表:
➜ ~ memo help
create name 創建新的備忘錄
change short name 切換備忘錄
del short name 刪除備忘錄
add memo string 給當前的備忘錄添加一條記錄
done memo string short name 標記當前備忘錄的某條備忘為已完成
show 列出當前備忘錄所有備忘
list 列出所有的備忘錄名稱
memo init
memo init
,這個命令用來初始化軟體,包括在用戶目錄下新建必要的文件、文件夾,執行
成功之後,會在家目錄下麵創建如下的內容:
/Users/ruitao/.memo/
是備忘錄軟體數據存放目錄,head_memo_name_record
用來記錄
當前備忘錄的名稱,initFlag
文件用來標記是否初始化過,memo/
目錄存放具體的備忘錄
信息,每個備忘錄一個文件。預設會創建一個預設備忘錄
,並將當前備忘錄指向他。
/Users/ruitao/.memo/
├── head_memo_name_record
├── initFlag
└── memo/
└── 預設備忘錄
memo create
memo create 工作備忘錄
,這個命令用來創建備忘錄,創建完成之後會在備忘錄數據目錄
創建/Users/ruitao/.memo/memo/工作備忘錄
文件
memo list
memo list
,這個命令用來列出備忘錄,如下麵所示,小手指向的就是當前所在的備忘錄,
另外備忘錄前面有一串字母,這裡是備忘錄的標識,後面刪除、切換備忘錄的時候都要用到
他。
➜ cli-memo git:(master) bin/memo list
備忘錄列表
☞ a69b36c0 預設備忘錄
8c13e2c7 工作備忘錄
memo change
memo change <shortName>
,這個命令用來切換當前的備忘錄,跟git切換分支類似。就像
下麵這樣,切換之後,就會切換到備忘錄[4be22fcf MCN備忘錄]。
➜ ~ memo list
備忘錄列表
☞ 45e43b27 生活備忘錄
4be22fcf MCN備忘錄
8c13e2c7 工作備忘錄
a69b36c0 預設備忘錄
➜ ~ memo change 4be22fcf
切換備忘錄[4be22fcf => MCN備忘錄]成功
➜ ~ memo list
備忘錄列表
☞ 4be22fcf MCN備忘錄
8c13e2c7 工作備忘錄
45e43b27 生活備忘錄
a69b36c0 預設備忘錄
memo del
memo del <shortName>
,這個命令用來刪除不需要的備忘錄,但是不能刪除當前正在使用的分支
,就像下麵這樣:
➜ ~ memo list
備忘錄列表
☞ 45e43b27 生活備忘錄
4be22fcf MCN備忘錄
8c13e2c7 工作備忘錄
a69b36c0 預設備忘錄
➜ ~ memo del a69b36c0
刪除備忘錄[a69b36c0 => 預設備忘錄]成功
➜ ~ memo list
備忘錄列表
☞ 45e43b27 生活備忘錄
4be22fcf MCN備忘錄
8c13e2c7 工作備忘錄
[memo show]|[memo]
memo show
和命令memo
是等價的,為了便於查看,預設命令設為memo show
,如下所示:
其中分為兩大類:待完成事項、已完成事項,待完成事項排列在前面,標記為已完成的事項
排列在後面。
➜ ~ memo show
生活備忘錄
待完成事項:
☞ 5e23fd6d 每天堅持遠眺
☞ 7f3fc212 翻譯文章《The Incredible Growth of Python》
已完成事項:
✔ 5a71bbc5 每天看書兩個小時
➜ ~ memo
生活備忘錄
待完成事項:
☞ 5e23fd6d 每天堅持遠眺
☞ 7f3fc212 翻譯文章《The Incredible Growth of Python》
已完成事項:
✔ 5a71bbc5 每天看書兩個小時
memo add
memo add <string>
,在當前備忘錄添加備忘記錄,如下所示:
➜ ~ memo add 今天提測同步數據介面
添加備忘[今天提測同步數據介面]到備忘錄[生活備忘錄]成功
➜ ~ memo
生活備忘錄
待完成事項:
☞ 5e23fd6d 每天堅持遠眺
☞ 7f3fc212 翻譯文章《The Incredible Growth of Python》
☞ 887bad83 今天提測同步數據介面
已完成事項:
✔ 5a71bbc5 每天看書兩個小時
memo done
memo done <shortName>
,在當前備忘錄標記shortName
對應的備忘記錄為已完成,如下
所示:
➜ ~ memo done 887bad83
備忘[887bad83 => 今天提測同步數據介面]標記已完成成功
➜ ~ memo
生活備忘錄
待完成事項:
☞ 5e23fd6d 每天堅持遠眺
☞ 7f3fc212 翻譯文章《The Incredible Growth of Python》
已完成事項:
✔ 5a71bbc5 每天看書兩個小時
✔ 887bad83 今天提測同步數據介面
TODO
- 因為短名稱
shortName
使用的是md5的前幾位,所以還是有一定幾率重覆的,這裡需要解決下。 - 添加時間概念,新建的時候添加什麼時候提醒,發送郵件。
- 解決win顯示問題,沒顏色可以顯示整齊點兒。