Crates.io | jirust-cli |
lib.rs | jirust-cli |
version | 0.9.7 |
source | src |
created_at | 2024-08-13 13:02:12.612987 |
updated_at | 2024-10-19 16:06:05.036259 |
description | A CLI tool to interact with Jira |
homepage | |
repository | https://github.com/ilpanich/jirust-cli |
max_upload_size | |
id | 1336011 |
size | 242,999 |
Component | Tests | Build | Crate | docs | rust-clippy |
---|---|---|---|---|---|
jirust-cli | |||||
jira_v3_openapi |
JiRust-CLI will be a simple Jira CLI developed in rust languages. The main goals are
To install it simply run:
cargo install jirust-cli
To use it simply run:
jirust-cli --help
And you will see the help message.
To configure the CLI you need to create a configuration file in your home directory called .jirust-cli/jirust-cli.toml
.
You cangenerate it (if the file doesn't exist the CLI will ask you to configure itself at the first run and the it will store the config in the file) by:
jirust-cli config setup
And you will be asked to insert the configuration parameters.
The CLI is still under heavy development and the features are not complete. Currently the basic version management is implemented and you can:
Supported output formats are:
JSON (default)
Table
The project is still under heavy development and I will prioritize the features I need the most for my daily programmer life. Use in production at your own risk. The content of the openapi Jira lib is automatically generated from the Jira API openapi file, retrieved form the official Jira API v3 docs:
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
The documentation is generated using cargo doc --open
and it will open the documentation in your browser.
It is also available upon publish on jira_v3_openapi docs.rs for the Jira REST API v3 lib crate and on JiRust-CLI docs.rs for the lib crate used by the binary..
Since everything is still under heavy development the documentation is not complete and it will be updated as the project evolves.
Please notice that jira_v3_openapi docs is autogenerated from the openapi file and it is not complete and not always correct, but I wouldn't spend time to improve it..
Also some of the jirust-cli documentation is auto-generated by AI, I will improve it every time I found something to be fixed inside it.
Everything is currently released upon the crates.io platform, once new updates are available:
Next features to be integrated and supported are:
Those are mandatory for my work and I will prioritize them; other features will be added as needed. You can request a feature by opening an issue or you can provide an implementation compliant with what is currently developed in a PR.
Apache 2.0
Feel free to contribute to the project. I will be happy to accept any help and suggestion on how to make the code better or even to integrate new features developed by the community.
Since I work as developer and manager during the day, I will develop this project during the night and weekends, once I have time. If you want to support the project bringing me a coffee to keep me awake and coding, you can do it by clicking the link below:
Thank you for your support!