README

用于同步Toggl与Redmine的PHP CLI工具。

时间条目同步

目前只有time-entry-sync可用。

• 从Toggl到Redmine的单向同步
• Toggl标签名称与Redmine的映射
• 同步状态在Toggl中标记为标签#synched

安装

通过使用composer进行安装非常简单。安装composer后，您可以将命令全局安装或在每个项目中安装。

Docker

要使用Docker运行脚本，您可以构建镜像

docker build -t local/toggl2redmine .

然后您可以像这样运行它

docker run -v /path/to/toggl2redmine.yml:/app/vendor/undpaul/toggl2redmine/toggl2redmine.yml local/toggl2redmine time-entry-sync

全局

在全局安装中，toggl2redmine将作为命令行工具可用。

• 运行composer global require undpaul/toggl2redmine以全局安装。
• 将export PATH=~/.composer/vendor/bin:$PATH添加到您的.bashrc或.profile

安装后，您应该可以从任何位置运行toggl2redmine time-entry-sync ...。

本地

您可以在任何启用composer的项目中运行composer require undpaul/toggl2redmine，将此项目作为依赖项添加。

使用方法

您可以通过附加选项、使用配置文件或同时使用两者来运行全局或本地命令。命令行参数或选项将始终覆盖toggl2redmine.yml中的设置。

全局：toggl2redmine.php time-entry-sync ...

本地：./toggl2redmine time-entry-sync ...

命令行参数和选项

Usage:
 time-entry-sync [--workspace="..."] [--fromDate="..."] [--toDate="..."] [--defaultActivity="..."] redmineURL redmineAPIKey tooglAPIKey

Arguments:
 redmineURL            Provide the URL for the redmine installation
 redmineAPIKey         The APIKey for accessing the redmine API
 tooglAPIKey           API Key for accessing toggl API

Options:
 --workspace           Workspace ID to get time entries from
 --fromDate            From Date to get Time Entries from (default: "-1 day")
 --toDate              To Date to get Time Entries from (default: "now")
 --defaultActivity     Name of the default redmine activity to use for empty time entry tags (default: "")

配置

您可以在当前工作目录中放置一个toggl2redmine.yml以设置本地默认值。对于全局默认值，您可以在~/.toggl2redmine/toggl2redmine.yml中放置它。注意：本地和全局默认值不会合并。本地默认值始终优先于全局默认值，如果存在的话。

您可以在default.toggl2redmine.yml中找到toggl2redmine.yml的模板。请确保将其重命名为toggl2redmine.yml！

例如，要将默认配置模板添加到全局文件夹，您可以简单地输入

mkdir ~/.toggl2redmine
curl https://github.com/undpaul/toggle2redmine/blob/main/default.toggl2redmine.yml > ~/.toggl2redmine/toggl2redmine.yml