You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+43-2Lines changed: 43 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,9 @@ A simple Command Line Interface (CLI) tool to generate One-Time Password (OTP) c
6
6
#### Note 📋: _I realize this project might seem over-engineered, but I'm using it as a sandbox to experiment with testing methodologies, which will ultimately be a valuable addition to my portfolio._.
7
7
8
8
9
+
_(TOTP and other features coming soon)_ 🚀
10
+
11
+
9
12
## Features ✨
10
13
11
14
- Generate OTP codes using a secret key
@@ -41,12 +44,48 @@ To generate an OTP code, you will need to provide a secret key (in base32 encodi
41
44
42
45
### Basic Command
43
46
```bash
44
-
./otp-generator-cli --secret="your-secret-here"
47
+
./otp-generator-cli --secret="SECRETVALUEHERE" --account test@gmail.com --issuer outlook --duration 60 --length 10
48
+
```
49
+
50
+
### Help argument
51
+
```bash
52
+
./otp-generator-cli --help
53
+
```
54
+
55
+
### Secret argument
56
+
```bash
57
+
./otp-generator-cli --secret SECRETVALUEHERE
58
+
```
59
+
60
+
### Account argument
61
+
```bash
62
+
./otp-generator-cli --account test@gmail.com
63
+
```
64
+
65
+
### Issuer argument
66
+
```bash
67
+
./otp-generator-cli --issuer outlook
68
+
```
69
+
70
+
### Duration argument
71
+
```bash
72
+
./otp-generator-cli --duration 60
73
+
```
74
+
75
+
### Length argument
76
+
```bash
77
+
./otp-generator-cli --length 10
45
78
```
46
79
47
80
### Example:
48
81
```bash
49
-
./otp-generator-cli --secret="JBSWY3DPEHPK3PXP"
82
+
============================================
83
+
============================================
84
+
BEGIN
85
+
Code: 1617198347
86
+
END
87
+
============================================
88
+
============================================
50
89
```
51
90
52
91
This will generate the OTP code for the provided secret using the current time-based window.
@@ -99,6 +138,8 @@ If you'd like to contribute to this project, feel free to fork the repository, c
99
138
100
139
Please ensure that your changes adhere to the coding standards and include proper tests.
101
140
141
+
### **Especial thanks to github.com/pquerna!** 🤝
142
+
102
143
## License 📄
103
144
104
145
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
0 commit comments