Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikitaignatov/rusty-timelogger
Time logging cli for Jira
https://github.com/nikitaignatov/rusty-timelogger
jira jira-cli jira-worklog productivity rust timelog timelogging worklog
Last synced: 19 days ago
JSON representation
Time logging cli for Jira
- Host: GitHub
- URL: https://github.com/nikitaignatov/rusty-timelogger
- Owner: nikitaignatov
- License: apache-2.0
- Created: 2019-11-22T22:32:28.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-05T22:37:14.000Z (about 5 years ago)
- Last Synced: 2024-04-25T02:39:47.420Z (8 months ago)
- Topics: jira, jira-cli, jira-worklog, productivity, rust, timelog, timelogging, worklog
- Language: Rust
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rusty TimeLogger
* Main goal of this project is to learn rust language.
* Secondary goal is to create a cli that allows time logging from the terminal.
## Examples of usage
``` bash
# add a log entry for a given issue
rusty log 1h3m task-12 "worked on stuff"
# show work log entries.
rusty show
rusty show today
rusty show yesterday
# show total hours for the time period
rusty hours today
rusty hours yesterday
rusty hours 2019-01-20 2019-02-19
```
## Log
Log command should allow user to add a work entry with minimal typing effort.
Command should be used to log time after the work has been completed so the Begin time will be current time - the time spent on this work log.
### Params
| Name | Required | Description |
| ---------- | -------- | --------------------------------------------------------------------- |
| time-spent | Yes | Time spent on the task can be provided as 1h or 30m. |
| issue | Yes | Issue Key or Id of the ticket form the project management system. |
| comment | No | Comment should be used to described what has been done. |
| when | No | Defines when work has begun. By default `current-time` - `time-spent` |
### Usage
Below is the usage text for the log command
``` bash
Log command allows you to create a work log for a specific issue.
USAGE:
rusty log [OPTIONS] [comment]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-w, --when When did the work started
ARGS:
How much time was spent on this worklog. Examples: is 1h or 1h30m or 30m
Issue Key for this worklog. Examples: PROJ-1234
Describe what you have done
```
## Show
## Hours
## Config
In order to connect to Jira url and api key need to be configured. This version stores credentials on file system in plain text.
### Usage
``` bash
Config command allows to change some of the settings
USAGE:
rusty.exe config --jira-api-key --jira-host --jira-username
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
--jira-api-key api key for the jira account that will be used to log time.
--jira-host url to the jira instance
--jira-username username for the jira account that will be used to log time.
```
## References
- [rust learning](https://github.com/ctjhoa/rust-learning)
- [Awesome Rust Talks & Articles](https://github.com/nikitaignatov/awesome-rust-talks)
- [Rust comparison with C# - Nicholas Blumhardt](https://nblumhardt.com/2016/03/exploring-rust/)
- [Pipe results like Elixir or F#?](https://users.rust-lang.org/t/pipe-results-like-elixir/11175/19)