Skip to main content

A command-line tool for generating strong passwords and secret keys.

Project description


ClinKey

GitHub License PyPI - Version GitHub Release Date

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clinkey_cli-2.1.0.tar.gz (64.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clinkey_cli-2.1.0-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

Details for the file clinkey_cli-2.1.0.tar.gz.

File metadata

  • Download URL: clinkey_cli-2.1.0.tar.gz
  • Upload date:
  • Size: 64.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for clinkey_cli-2.1.0.tar.gz
Algorithm Hash digest
SHA256 71c9aeae077eee0bb29dff1d86f53e3643814a182e0f2ed4300430bd009bf657
MD5 35fd2b5f40ca61e74b166dd6e438eb39
BLAKE2b-256 a516bd9c0e0a06f69b6d429d0442ff6755d81324cf5893afcd5cf2139de8ac72

See more details on using hashes here.

File details

Details for the file clinkey_cli-2.1.0-py3-none-any.whl.

File metadata

  • Download URL: clinkey_cli-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 68.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for clinkey_cli-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 826bee54cf37dc5b7bb7abff1c1f998e70f22b029b1b163a5f59367491ac6ad5
MD5 63af4d6615aac22c6a6177e0861126c7
BLAKE2b-256 7ecb04ec623b6e29dd6e659e1b228182cc91cbeba2db2a0896d125044f4e8762

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page