---

Your SECRET BUDDY, assisting you in crafting strong passwords you can actually remember.

Installation

The easiest way is to use pip or pipx.

However we recommand to use uv

pip install clinkey-cli
# or
pipx install clinkey-cli
# or 
uv add clinkey-cli
# or
uv pip install clinkey-cli
# or
uv tool install clinkey-cli     # For a global setup

For macOS users, you can also use Homebrew:

• Replace / with the actual tap path

brew tap dim-gggl/clinkey-cli
brew install clinkey-cli

✨ Usage

clinkey works in two ways:

• Interactive Mode (cool and guided).

  Run clinkey with no arguments to launch the guided interface. It's the best way to get started !

• Direct Mode (fast and efficient).

  Use flags to get what you want in a single line.

The parameters

The types (-t | --type)

There are 3 different types of clinkey passwords :

• normal : set by default. Containing only letters. flag : -t | --type normal
• strong : like normal, but with digits. flag : -t | --type strong
• super_strong : like strong, but with special characters. flag : -t | --type super_strong.

Note that in interactive mode, as well as in the web interface, normal is called Vanilla, strong is called Twisted and super_strong is called So NAAASTY or Super Twisted.

The length (-l | --length)

The length of your password is set by default to 16 characters. You can change it by using the -l | --length flag, from 12 to 128 characters.

The number of passwords (-n | --number)

It is possible to generate multiple passwords at once by using the -n | --number flag, from 1 to 500 passwords.

The separator (-ns | --no-sep)

The pattern of passwords that clinkey uses hyphen and underscore as separators by default to make the whole result pronounceable. You can change it by using the -ns | --no-sep flag.

The lowercase (-low | --lower)

By default clinkey generates passwords in uppercase. You can change it by using the -low | --lower flag.

The output (-o | --output)

Eventually, you can save the result to a file and avoid echoing it to the terminal by using the -o | --output flag followed by the path to the file.

Security analysis (--analyze and analyze)

You can now audit password strength directly from the CLI:

# Analyze generated passwords right after creation
clinkey -t strong -n 3 --analyze

# Analyze with a hidden prompt
clinkey analyze

# Include breach lookup
clinkey analyze --breach

The analyze command shows:

• An overall score and strength label
• Entropy and length details
• Compliance status
• Detected risk flags
• Actionable recommendations