jira-daily-report 0.1.109 → 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 CHANGED
@@ -1,47 +1,54 @@
1
- # Jira Daily Report
1
+ # Jira Daily Report CLI
2
2
 
3
- Generate daily standup reports from Jira and Tempo time tracking - available as both a CLI tool and VS Code extension.
3
+ [![npm version](https://img.shields.io/npm/v/jira-daily-report.svg)](https://www.npmjs.com/package/jira-daily-report)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
5
 
6
+ A CLI tool for daily Jira reporting and Tempo time logging from your terminal.
5
7
 
6
8
  ## Installation
7
-
8
- ### CLI Tool (npm)
9
-
10
9
  ```bash
11
- # Global installation (recommended for CLI usage)
12
- pnpm install -g jira-daily-report
10
+ npm install -g jira-daily-report
13
11
  ```
14
12
 
13
+ ## Setup
15
14
 
16
- - **Jira API Token**: Get from https://id.atlassian.com/manage-profile/security/api-tokens
17
- - **Tempo API Token**: Get from https://your-domain.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration
18
-
19
- **Or use environment variables:**
20
-
15
+ Add these to your shell profile (`.bashrc`, `.zshrc`):
21
16
  ```bash
22
- # Add to your shell profile (.bashrc, .zshrc, .bash_profile)
23
-
24
17
  export JIRA_SERVER="https://your-domain.atlassian.net/"
25
- export JIRA_USERNAME="thuanvo@example.com"
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
- export WHO_AM_I="Developer" # or "QC"
29
-
30
- # Reload your shell configuration
31
- source ~/.zshrc # or ~/.bashrc
32
21
  ```
33
22
 
34
- ### CLI Commands
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)
35
26
 
36
- ##### `jira-report generate`
27
+ ## Usage
37
28
 
29
+ **Generate daily report:**
30
+ ```bash
31
+ jira-report generate
32
+ ```
33
+
34
+ **Log time:**
35
+ ```bash
36
+ # Single ticket
37
+ jira-report logtime "B2B-1079 2h"
38
+
39
+ # Multiple tickets
40
+ jira-report logtime "B2B-1079 2h, PROJECT-123 1.5h"
38
41
 
39
- ### Requirements
42
+ # Specific date
43
+ jira-report logtime "B2B-1079 2h" --date yesterday
44
+ jira-report logtime "B2B-1079 2h" --date 2025-01-15
40
45
 
41
- - Node.js >= 16.0.0
42
- - Jira Server access with API token
46
+ # With description
47
+ jira-report logtime "B2B-1079 2h" --description "Bug fix"
48
+ ```
43
49
 
44
- ### Support
50
+ **Time formats:** `2h`, `1.5h`, `30m`, `1h 30m`
45
51
 
46
- For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
52
+ ## License
47
53
 
54
+ MIT