#jira #version #interact #projects #basic #cli #issue

bin+lib jirust-cli

一个用于与 Jira 交互的 CLI 工具

7 个版本

新增 0.8.4 2024 年 8 月 21 日
0.8.3 2024 年 8 月 19 日
0.7.4 2024 年 8 月 15 日
0.5.0 2024 年 8 月 13 日

#99 in 压缩

Download history 125/week @ 2024-08-07 414/week @ 2024-08-14

每月 539 次下载

Apache-2.0

3MB
43K SLoC

JiRust-CLI

组件 测试 构建 文档
jirust-cli Tests build and release jirust-cli Crate API
jira_v3_openapi Tests build and release jira_v3_openapi Crate API

JiRust-CLI 将是一个用 Rust 语言开发的简单 Jira CLI。主要目标是

  • 提供一个简单易用的终端与 Jira 交互的方式
  • 亲自体验 Rust 语言
  • 提供一个目前找不到的 Jira API 的 Rust 实现

安装

要安装它,只需运行

cargo install jirust-cli

用法

要使用它,只需运行

jirust-cli --help

您将看到帮助信息。

配置

要配置 CLI,您需要在您的家目录中创建一个名为 .jirust-cli/jirust-cli.toml 的配置文件。

您可以通过以下方式生成它(如果文件不存在,CLI 将在第一次运行时要求您配置自己,然后将其存储在文件中):

jirust-cli config setup

您将被要求输入配置参数。

功能

CLI 目前仍在积极开发中,功能尚不完整。目前实现了基本版本管理,您可以

  • 列出项目的版本
  • 创建新版本
  • 删除版本
  • 更新版本
  • 发布版本
  • 归档版本
  • 列出所有项目
  • 列出给定项目中的所有问题类型
  • 列出给定项目中给定问题类型的所有字段

开发

该项目仍在积极开发中,我将优先考虑我最需要的特性,以用于我的日常程序员生活。在您的生产环境中使用时请自担风险。openapi Jira 库的内容是自动从 Jira API openapi 文件生成的

openapi-generator-cli generate -g rust -o ~/git/priv/jirust-cli/jira_v3_openapi -i jira-v3-openapi-spec/swagger.v3.json --additional-properties=bestFitInt=true,preferUnsignedInt=true,supportMiddleware=true

文档

该文档使用 cargo doc --open 生成,它将在您的浏览器中打开文档。它还可在发布后在 jira_v3_openapi docs.rs(用于 Jira REST API v3 库)和 JiRust-CLI docs.rs(用于二进制库)上找到。由于所有内容都在进行大量开发,文档尚未完整,并将随着项目的发展而更新。请注意,jira_v3_openapi 文档是从 openapi 文件自动生成的,可能不完整且不一定正确,但我不会花时间去改进它。

此外,jirust-cli 的一些文档也是由 AI 自动生成的,我会每次发现需要修复的内容时进行改进。

发布

目前所有内容都在 crates.io 平台上发布,一旦有新的更新可用。

路线图

即将集成和支持的功能包括

  • 问题管理
  • 项目管理

这些是我工作的必备功能,我将优先处理它们;其他功能将根据需要添加。您可以通过打开问题来请求功能,或者您可以通过提供符合当前开发情况的 PR 来提供实现。

许可证

Apache 2.0

贡献

请随时为项目做出贡献。我将很高兴接受任何有助于改进代码或集成社区开发的新功能的帮助和建议。

支持项目

由于我白天既是开发者又是经理,我将在晚上和周末开发这个项目,一旦我有时间。如果您想通过点击下面的链接为我买杯咖啡来支持项目,以保持我清醒并编码,您可以这样做。

ko-fi

感谢您的支持!

依赖项

~15–29MB
~424K SLoC