redmine-time-logger
v1.0.6
Published
A command line tool to log time entries in Redmine.
Downloads
2
Readme
Redmine Time Logger
Redmine Time Logger 是一个命令行工具,用于通过 Redmine 的 REST API 为指定任务创建工时记录。该工具支持为一段时间内的每一天批量记录工时,并允许用户自定义工时数量和添加工作注释。
特性
- API 密钥和服务器 URL 配置: 通过简单的配置文件设置和存储您的 Redmine API 密钥和服务器地址。
- 日期范围记录: 支持通过命令行参数指定日期范围(如从五天前到今天)。
- 自定义工时数: 默认每天记录8小时工时,但用户可以自定义每天的工时数。
- 添加注释: 支持为工时记录添加自定义注释。
安装
首先,确保您已经安装了 Node.js 和 npm。然后,您可以使用 npm 将 Redmine Time Logger 安装为全局包:
npm install -g redmine-time-logger
配置
支持在第一次执行时使用交互式命令行写入配置,也可以在您的个人目录下手动创建一个名为 .redmine-config.json 的文件,并添加以下内容:
{
"apiKey": "your-redmine-api-key",
"apiUrl": "https://your-redmine-url.com"
}
使用
使用 Redmine Time Logger 记录工时非常简单。以下是一些示例命令:
# 为任务 #1234 记录今天 8 小时工时
redmine-hours 1234 -d 0 -h 8
# 为任务 #1234 记录从五天前到今天的每天 8 小时工时
redmine-hours 1234 -d -5 -d 0 -h 8
# 为任务 #1234 记录今天 10 小时工时,并添加注释
redmine-hours 1234 -d 0 -h 10 -c "Completed task XYZ"