jira-daily-report 0.1.110 → 0.1.111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -64
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,96 +1,54 @@
|
|
|
1
|
-
|
|
1
|
+
# Jira Daily Report CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/jira-daily-report)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
- Time Logging
|
|
7
|
-
---
|
|
6
|
+
A CLI tool for daily Jira reporting and Tempo time logging from your terminal.
|
|
8
7
|
|
|
9
8
|
## Installation
|
|
10
|
-
|
|
11
|
-
### CLI Tool (Global)
|
|
12
|
-
|
|
13
9
|
```bash
|
|
14
|
-
# Install globally using npm/pnpm/yarn
|
|
15
10
|
npm install -g jira-daily-report
|
|
16
11
|
```
|
|
17
12
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
Environment variables take precedence over config files:
|
|
13
|
+
## Setup
|
|
21
14
|
|
|
15
|
+
Add these to your shell profile (`.bashrc`, `.zshrc`):
|
|
22
16
|
```bash
|
|
23
|
-
# Add to your shell profile (.bashrc, .zshrc, .bash_profile)
|
|
24
17
|
export JIRA_SERVER="https://your-domain.atlassian.net/"
|
|
25
18
|
export JIRA_USERNAME="your-email@example.com"
|
|
26
19
|
export JIRA_API_TOKEN="your-jira-api-token"
|
|
27
20
|
export TEMPO_API_TOKEN="your-tempo-api-token"
|
|
28
|
-
|
|
29
|
-
# Optional settings
|
|
30
|
-
export WHO_AM_I="Developer" #or "QC"
|
|
31
|
-
export AUTO_CLIPBOARD="true"
|
|
32
|
-
|
|
33
|
-
# Reload your shell configuration
|
|
34
|
-
source ~/.zshrc # or ~/.bashrc
|
|
35
21
|
```
|
|
36
22
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
- **
|
|
40
|
-
- **Tempo API Token**: https://apidocs.tempo.io/#section/Authentication
|
|
41
|
-
- Go to: `https://your-domain.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration`
|
|
42
|
-
|
|
43
|
-
---
|
|
44
|
-
|
|
45
|
-
## CLI Commands
|
|
46
|
-
|
|
47
|
-
### 1. `jira-report generate`
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
### 2. `jira-report logtime`
|
|
23
|
+
**Get your tokens:**
|
|
24
|
+
- **Jira:** [Create API token](https://id.atlassian.com/manage-profile/security/api-tokens)
|
|
25
|
+
- **Tempo:** Go to `https://your-domain.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration` (replace `your-domain` with your Jira domain)
|
|
53
26
|
|
|
54
|
-
|
|
27
|
+
## Usage
|
|
55
28
|
|
|
56
|
-
**
|
|
29
|
+
**Generate daily report:**
|
|
30
|
+
```bash
|
|
31
|
+
jira-report generate
|
|
32
|
+
```
|
|
57
33
|
|
|
34
|
+
**Log time:**
|
|
58
35
|
```bash
|
|
59
|
-
#
|
|
36
|
+
# Single ticket
|
|
60
37
|
jira-report logtime "B2B-1079 2h"
|
|
61
38
|
|
|
62
|
-
#
|
|
63
|
-
jira-report logtime "B2B-1079 2h, PROJECT-123 1.5h
|
|
39
|
+
# Multiple tickets
|
|
40
|
+
jira-report logtime "B2B-1079 2h, PROJECT-123 1.5h"
|
|
64
41
|
|
|
65
|
-
#
|
|
42
|
+
# Specific date
|
|
66
43
|
jira-report logtime "B2B-1079 2h" --date yesterday
|
|
67
|
-
|
|
68
|
-
# Log time for a specific date
|
|
69
44
|
jira-report logtime "B2B-1079 2h" --date 2025-01-15
|
|
70
45
|
|
|
71
|
-
#
|
|
72
|
-
jira-report logtime "B2B-1079 2h
|
|
73
|
-
|
|
46
|
+
# With description
|
|
47
|
+
jira-report logtime "B2B-1079 2h" --description "Bug fix"
|
|
74
48
|
```
|
|
75
49
|
|
|
76
|
-
**
|
|
77
|
-
|
|
78
|
-
The timesheet format supports flexible time notation:
|
|
79
|
-
|
|
80
|
-
- `2h` - 2 hours
|
|
81
|
-
- `1.5h` - 1 hour 30 minutes
|
|
82
|
-
- `30m` - 30 minutes
|
|
83
|
-
- `1h 30m` - 1 hour 30 minutes (combined)
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
## Support
|
|
88
|
-
|
|
89
|
-
For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
|
|
90
|
-
|
|
91
|
-
---
|
|
50
|
+
**Time formats:** `2h`, `1.5h`, `30m`, `1h 30m`
|
|
92
51
|
|
|
93
52
|
## License
|
|
94
53
|
|
|
95
54
|
MIT
|
|
96
|
-
|
package/package.json
CHANGED