Skip to content

Commit ec3e87a

Browse files
✨ Adding sub-command descriptions
1 parent 1e618c7 commit ec3e87a

File tree

3 files changed

+20
-24
lines changed

3 files changed

+20
-24
lines changed

README.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,16 @@
1212
# JWT CLI
1313

1414
[![Release](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/release.yml/badge.svg)](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/release.yml)
15-
[![Code quality checks](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/code-quality-checks.yml/badge.svg?branch=master)](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/code-quality-checks.yml)
16-
17-
[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=rrajesh1979_ref-java-jwt)](https://sonarcloud.io/summary/new_code?id=rrajesh1979_ref-java-jwt)
18-
15+
[![Code quality checks](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/code-quality-checks.yml/badge.svg?branch=master)](https://github.com/rrajesh1979/ref-java-jwt/actions/workflows/code-quality-checks.yml)
16+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=rrajesh1979_ref-java-jwt&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=rrajesh1979_ref-java-jwt)
1917
![GitHub release (latest by date)](https://img.shields.io/github/v/release/rrajesh1979/ref-java-jwt)
20-
2118
![GitHub last commit](https://img.shields.io/github/last-commit/rrajesh1979/ref-java-jwt)
2219
![GitHub commit activity](https://img.shields.io/github/commit-activity/y/rrajesh1979/ref-java-jwt)
2320
![GitHub pull requests](https://img.shields.io/github/issues-pr/rrajesh1979/ref-java-jwt)
2421
![GitHub issues](https://img.shields.io/github/issues/rrajesh1979/ref-java-jwt)
25-
2622
![GitHub contributors](https://img.shields.io/github/contributors/rrajesh1979/ref-java-jwt)
2723
![GitHub watchers](https://img.shields.io/github/watchers/rrajesh1979/ref-java-jwt)
24+
![Known Vulnerabilities](https://snyk.io/test/github/rrajesh1979/ref-java-jwt/badge.svg)
2825

2926
<a href="https://github.com/rrajesh1979/ref-java-jwt/graphs/contributors">
3027
<img src="https://contrib.rocks/image?repo=rrajesh1979/ref-java-jwt" alt="Contributors"/>
@@ -45,45 +42,44 @@ Made with [contrib.rocks](https://contrib.rocks).
4542

4643
## Key Features
4744
<div>
48-
This is a reference implementation that can serve as a jump start application. This reference GitHub repo is built using
45+
This is a JWT CLI tool that is intended to serve as a reference implementation. This reference GitHub repo is built using
4946
<ul>
5047
<li>Java</li>
5148
<li>Maven</li>
52-
<li>JReleaser</li>
5349
<li>Picocli</li>
54-
<li>Code Quality tools</li>
50+
<li>JReleaser</li>
51+
<li>CodeCov for code coverage</li>
52+
<li>Codeclimate and SonarCloud for quality checks</li>
5553
<li>GitHub Actions and Workflows</li>
5654
<li>GitPod environment</li>
57-
<li>Spock and JUnit tests</li>
58-
<li>Using Git Emojis</li>
55+
<li>JUnit tests</li>
5956
</ul>
6057
</div>
6158

6259
## Getting started
6360

64-
Once you have build and released the application, you can use the following commands to deploy the application to your Mac, Linux or Windows machine.
61+
Once you have built and released the application, you can use the following commands to deploy the application to your Mac, Linux or Windows machine.
6562
This is powered by GraalVM native image and distribution using JReleaser and GitHub Actions and Workflow.
6663
```shell
6764
# Substitute your username
6865
# Deploy to Mac
6966
brew tap rrajesh1979/tap
70-
brew install mychecksum
67+
brew install jwtc
7168
```
7269

73-
Once installed you can invoke mychecksum with the file name and algorithm as shown below.
70+
Once installed you can invoke jwtc with the file name and algorithm as shown below.
7471

7572
Invoking the command displays the usage information as shown below. This is powered by Picocli.
7673
```shell
77-
mychecksum
78-
11:01:36.098 [main] INFO org.rrajesh1979.demo.MyCheckSum - Hello from MyCheckSum
79-
Missing required parameter: '<file>'
80-
Usage: mychecksum [-hV] [-a=<algorithm>] <file>
81-
Prints the checksum (MD5 by default) of a file to STDOUT.
82-
<file> The file whose checksum to calculate.
83-
-a, --algorithm=<algorithm>
84-
MD5, SHA-1, SHA-256, ...
74+
jwtc help
75+
Usage: jwtc [-hV] [COMMAND]
76+
Encode and decode JWT tokens.
8577
-h, --help Show this help message and exit.
8678
-V, --version Print version information and exit.
79+
Commands:
80+
help Displays help information about the specified command
81+
encode
82+
decode
8783
```
8884

8985
Some valid commands are shown below.

src/main/java/org/rrajesh1979/tool/JWTCDecode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import picocli.CommandLine.Command;
2424
import picocli.CommandLine.Option;
2525

26-
@Command(name = "decode")
26+
@Command(name = "decode", description = "Decode JWT token")
2727
@Slf4j
2828
public class JWTCDecode implements Runnable {
2929
@Option(names = { "-j", "--jwt" }, description = "JWT String to be decoded.", required = true)

src/main/java/org/rrajesh1979/tool/JWTCEncode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
import picocli.CommandLine.Command;
2424
import picocli.CommandLine.Option;
2525

26-
@Command(name = "encode")
26+
@Command(name = "encode", description = "Encodes a JWT token")
2727
@Slf4j
2828
public class JWTCEncode implements Runnable {
2929
@Option(names = { "-a",

0 commit comments

Comments
 (0)