Pickler 使用与技术文档

1. 安装指南

首先，确保您的环境中已安装了Ruby和gem。接下来，按照以下步骤安装Pickler：

gem install pickler

安装完成后，配置Pivotal Tracker的API token和项目ID。在~/.tracker.yml文件中输入您的API token：

api_token: <您的API Token>

在~/my/app/features/tracker.yml文件中输入您的项目ID：

project_id: <您的项目ID>

2. 项目使用说明

以下是Pickler提供的命令及其功能说明：

• pickler pull：下载所有处于非“未开始”或“未安排”状态的故事到features/目录。
• pickler push：上传所有在第一行评论中包含tracker URL的特性。
• pickler search <query>：列出所有与给定查询匹配的故事。
• pickler start <story> <name>：将指定的特性拉到features/<name>.feature并更改其状态为“开始”。
• pickler start <story> -：根据标题将特性拉到文件并更改其状态为“开始”。
• pickler finish <story>：推送指定的特性并更改其状态为“完成”。
• pickler install-vim-plugin [<directory>]：将Vim插件安装到指定目录，或在未指定时安装到~/.vim/plugin。此插件目前仅提供在Git提交消息中特性ID的omnicomplete（CTRL-X, CTRL-O）功能。
• pickler --help：显示完整的命令列表。
• pickler <command> --help：为给定命令提供更多帮助。

3. 项目API使用文档

Pickler依赖于Pivotal Tracker API，您可以在这里找到关于API token和项目ID的详细信息。

• API Token：在Pivotal Tracker中找到您的API token，通常位于账户设置中。
• 项目ID：在Pivotal Tracker中找到您的项目ID。

注意事项：在使用pull和push命令时，请确保您的特性文件格式正确，避免覆盖其他文件。

4. 项目安装方式

Pickler的安装方式已在“安装指南”部分详细说明，请参考上文进行安装。

以上就是Pickler的使用和技术文档，希望对您有所帮助。