chore: Update documentation with v1.1.0

docs/.vitepress/config.mts

@@ -43,6 +43,7 @@ export default defineConfig({
         text: 'Company',
         collapsed: false,
 	items: [
+          { text: 'all', link: '/company/all' },
           { text: 'start-caps', link: '/company/start-caps' },
           { text: 'leet', link: '/company/leet' },
           { text: 'mask', link: '/company/mask' },
@@ -51,6 +52,7 @@ export default defineConfig({
           { text: 'mixed-case', link: '/company/mixed-case' },
           { text: 'year', link: '/company/year' },
           { text: 'numbers', link: '/company/numbers' },
+          { text: 'postal', link: '/company/postal' },
         ]
       }
     ],

docs/company/all.md

@@ -0,0 +1,30 @@
+# All
+
+The `--all` and `-a` flag can be used to apply all mutations.
+
+```bash
+> passfinder company -n passfinder -a
+
+? 1215900 passwords will be generated, do you want to continue? (y/N)
+
+[...]
+P@5$fINDeR%24
+P@5sfIND3R%24
+P@5sfINDeR%24
+P@$5fIND3R%24
+P@$5fINDeR%24
+P@$$fIND3R%24
+P@$$fINDeR%24
+P@$sfIND3R%24
+P@$sfINDeR%24
+P@s5fIND3R%24
+P@s5fINDeR%24
+P@s$fIND3R%24
+P@s$fINDeR%24
+P@ssfIND3R%24
+P@ssfINDeR%24
+Pa55fIND3R%24
+Pa55fINDeR%24
+Pa5$fIND3R%24
+[...]
+```

docs/company/end-special.md

@@ -1,6 +1,6 @@
 # End-special
 
-The `--end-special` flag adds a special charset character to the end of the password.
+The `--end-special` and `-s` flag adds a special charset character to the end of the password.
 
 ```bash
 > passfinder company -n passfinder --end-special

docs/company/leet.md

@@ -1,6 +1,6 @@
 # Leet
 
-The `--leet` flag can be used to transform letters into numbers or symbols.
+The `--leet` and `-l` flag can be used to transform letters into numbers or symbols.
 
 ```bash
 > passfinder company -n passfinder --leet

docs/company/mask.md

@@ -1,6 +1,6 @@
 # Mask
 
-The `--mask` flag is used to add a mask to a password. The mask works like the john tool with :
+The `--mask` and `-m` flag is used to add a mask to a password. The mask works like the john tool with :
 
 * `%w` -> word
 * `%s` -> symbols

docs/company/mixed-case.md

@@ -1,6 +1,6 @@
 # Mixed-case
 
-The `--mixed-case` flag allows you to mix the case of a password, alternating between upper and lower case.
+The `--mixed-case` and `-c` flag allows you to mix the case of a password, alternating between upper and lower case.
 
 ```bash
 > passfinder company -n passfinder --mixed-case

docs/company/numbers.md

@@ -1,9 +1,9 @@
 # Numbers
 
-The `--numbers` flag adds numbers from 0 to 20 (default) 
+The `--numbers` flag adds numbers to the company name. It waits for a maximum value and then iterates on it.
 
 ```bash
-> passfinder company -n passfinder --numbers
+> passfinder company -n passfinder --numbers 5
 
 passfinder
 passfinder0
@@ -12,27 +12,10 @@ passfinder2
 passfinder3
 passfinder4
 passfinder5
-passfinder6
-passfinder7
-passfinder8
-passfinder9
-passfinder10
-passfinder11
-passfinder12
-passfinder13
-passfinder14
-passfinder15
-passfinder16
-passfinder17
-passfinder18
-passfinder19
-passfinder20
 ```
 
-The `--numbers-range` flag is used to adjust the range size.
-
 ```bash
-> passfinder company -n passfinder --numbers --numbers-range 5
+> passfinder company -n passfinder --numbers 10
 
 passfinder
 passfinder0
@@ -41,4 +24,9 @@ passfinder2
 passfinder3
 passfinder4
 passfinder5
+passfinder6
+passfinder7
+passfinder8
+passfinder9
+passfinder10
 ```

docs/company/postal.md

@@ -0,0 +1,10 @@
+# Postal
+
+The `--postal` and `-p` flags can be used to add a zip code after the company name.
+
+```bash
+> passfinder company -n passfinder --postal 69000
+
+passfinder
+passfinder69000
+```

docs/company/short-year.md

@@ -1,11 +1,22 @@
 # Short-year
 
-The `--short-year` flag adds a year to the end of the company name, but only the last 2 digits (eg. `24` for `2024`).
+The `--short-year` flag adds a year to the end of the company name, but only the last 2 digits (eg. `24` for `2024`). By default, it expects a value of `0` for the current year. You can also add a year range. For example, 2 will display the 2 years before and after the current year.
 
 
 ```bash
-> passfinder company -n passfinder --short-year
+> passfinder company -n passfinder --short-year 0
 
 passfinder
 passfinder24
+```
+
+```bash
+> passfinder company -n passfinder --short-year 2
+
+passfinder
+passfinder22
+passfinder23
+passfinder24
+passfinder25
+passfinder26
 ```

docs/company/start-caps.md

@@ -1,6 +1,6 @@
 # Start-caps
 
-The `--start-caps` flag adds a capital letter to the beginning of the password.
+The `--start-caps` and `-b` flag adds a capital letter to the beginning of the password.
 
 ```bash
 > passfinder company -n passfinder --start-caps

docs/company/year.md

@@ -1,18 +1,29 @@
 # Year
 
-The `--year` flag is used to add the current year to the end of a password.
+The `--year` and `-y` flag is used to add the current year to the end of a password. By default, it expects a value of `0` for the current year. You can also add a year range. For example, 2 will display the 2 years before and after the current year.
 
 ```bash
-> passfinder company -n passfinder --year
+> passfinder company -n passfinder --year 0
 
 passfinder
 passfinder2024
 ```
 
+```bash
+> passfinder company -n passfinder --year 2
+
+passfinder
+passfinder2022
+passfinder2023
+passfinder2024
+passfinder2025
+passfinder2026
+```
+
 The `--year-separators` flag is used to add a special character between the company name and the year.
 
 ```bash
-> passfinder company -n passfinder --year --year-separators
+> passfinder company -n passfinder --year 0 --year-separators
 
 passfinder
 passfinder2024
@@ -24,12 +35,13 @@ passfinder%2024
 passfinder+2024
 passfinder?2024
 passfinder=2024
+passfinder*2024
 ```
 
 This option also works with `--short-year`.
 
 ```bash
-> passfinder company -n passfinder --short-year --year-separators
+> passfinder company -n passfinder --short-year 0 --year-separators
 
 passfinder
 passfinder24

docs/getting-started/home.md

@@ -35,7 +35,7 @@ title: 'Passfinder - Generate custom password wordlists !'
 </div>
 
 ::: warning
-The latest version is `1.0.0`, which is a beta version. Bugs may still exist.
+The latest version is `1.1.0`, which is a beta version. Bugs may still exist.
 :::
 
 Passfinder is a command-line interface (CLI) tool developed in Golang, designed to generate probable password wordlists based on a variety of customizable options. This tool is especially useful for security professionals, penetration testers, and Red Team members. By providing precise and relevant password lists tailored to specific criteria such as a company name, the current year, or the city, passfinder enhances the efficiency of security testing and attack simulations. Whether for security audits, red teaming exercises, or assessing system robustness, passfinder proves to be a powerful and indispensable ally in anticipating and mitigating security vulnerabilities.

docs/getting-started/installation.md

@@ -5,7 +5,7 @@
 The stable (release) version can be downloaded using the following command :
 
 ```bash
-go install https://github.com/GoToolSharing/passfinder
+go install https://github.com/GoToolSharing/passfinder@v1.1.0
 ```
 
 ## Dev