作一個CLI版的時間管理工具（九）

作一個CLI版的時間管理工具（九）

這是我參與8月更文挑戰的第10天，活動詳情查看：8月更文挑戰」

前言

上一篇文章主要闡述了自動記錄事務的邏輯

經過前面8篇文章的介紹，這個工具目前已經可以進行初步的使用

本文將從頭至尾的介紹一下已經開發的核心功能的使用

使用

安裝

1. 須要電腦上安裝Node
2. 若是依賴找不到，請先將npm源切換爲官方源

npm config set registry https://registry.npmjs.org/
複製代碼

安裝

npm install -g time-control
複製代碼

查看支持的指令

經過8天的不懈努力，能夠看到咱們已經開發出了不少的指令，下面將演示一下核心的幾個：

• 自動記錄
• 生成周報/日報/月報（時間報告）

timec --help
複製代碼

項目初始化

建立一個用於記錄的項目

timec init timeLog
複製代碼

建立文件

建立一個用於自動寫入內容的文件

timec create auto.md
複製代碼

建立的模板文件會有一些內容，能夠手動清除一下

設置文件路徑

設置自動記錄文件的路徑

timec upPath ./auto.md 
複製代碼

任務管理

查看正在進行中的任務

timec task 
複製代碼

建立新的任務

timec task <name>
複製代碼

切換任務,這裏和建立任務同樣的指令與參數

若是任務已存在就選擇使用這個任務

timec task <name>
複製代碼

刪除已存在的任務

• 加上-doption就表明是移除這個任務

timec task -d <name>
複製代碼

事務管理

開始一個新的事務

timec thing <name>
複製代碼

查看當前進行中的事務

timec thing
複製代碼

結束當前事務

• 加上-s參數便可
• 結束事務，會自動將剛剛進行的事務記錄到文件中

timec thing -s
複製代碼

不切換事務，直接開始新的事務

• 將進行中的直接結束，而後將結果寫入文件中
• 而後開始新的事務

timec thing <name>
複製代碼

注：事務記錄的數字是，事務的耗時，單位是小時（hours）保留5位小數

事務相關的操做到這就演示完畢了

有了事務記錄的數據，下面就是生成報告了

下面將介紹到戶導出功能

多樣化導出

導出爲JSON

開發者們能夠用這串json，本身進行個性化的分析

timec -oj <filepath>
複製代碼

導出Markdown

加上-t選項可爲md文件加上詳細的耗時，包含事務，任務，天維度

timec -omt <filepath>
複製代碼

生成日報

指定要查看的日期和分析的文件便可：

• 生成的報告包含，一天的總耗時，某個任務的總耗時

timec -or -D <date> <filepath>
複製代碼

生成月報

經過-M指定要查看的月份便可

timec -or -M <month> <filepath>
複製代碼

一段時間的報告

能夠用這個生成周報，任意時間範圍的報告

timec -or -R <startTime_endTime> <filepath>
複製代碼

小結

核心的功能基本都詳細介紹完畢，演示過程當中發現了一些bug，留到下期進行優化

數據展現這一塊後續也將爲你們帶來豐富的功能，靈感還在，只差時間

其它

因爲天天空閒時間有限，本文就先到這

若是讀者還感受意猶未盡，敬請期待後續更新，或持續關注一下倉庫的狀態

歡迎評論區提需求，交流探討

本系列會不斷的更新迭代，直至產品初代完成

• 倉庫地址