Skip to content

Commit a3cd74d

Browse files
committed
docs: update README.md with help and generate-password command details
Add detailed usage information for the help and generate-password commands, including available commands, flags, and examples to improve user guidance.
1 parent a3cb456 commit a3cd74d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,31 @@ go install
3030
```
3131

3232
## Usage
33+
### Help Command
34+
Display help information.
35+
```bash
36+
helpme help
37+
helpme [command] help
38+
39+
Available Commands:
40+
completion Generate the autocompletion script for the specified shell
41+
encode encode file or text
42+
find Find an example for a given function
43+
generate-password Generate a password
44+
help Help about any command
45+
pull Pull depdency golang
46+
runtest Run Test sample with sample output
47+
setup Setup project templates
48+
sharefile Share workspace directory with same network
49+
trackclipboard Track data from clipboard and send to your channel
50+
51+
Flags:
52+
-c, --cpuprofile enable cpu profiling
53+
-h, --help help for helpme
54+
-m, --memprofile enable memory profiling
55+
-v, --version version for helpme
56+
```
57+
3358

3459
### Find Command
3560
Search for code examples in different programming languages.
@@ -57,6 +82,12 @@ Generate secure passwords with customizable options.
5782

5883
```bash
5984
helpme generate-password [flags]
85+
86+
Flags:
87+
-h, --help help for generate-password
88+
-l, --len int Password length (words or chars)
89+
-q, --qty int Quantity of passwords to generate (default 1)
90+
-t, --type int Password type (0: word, 1: phrase, 2: word with special, 3: phrase with special, 4: secure)
6091
```
6192

6293
### Pull Command

0 commit comments

Comments
 (0)