Go to file

Release Bot b11fcecbd9 ci/woodpecker/push/publish Pipeline failed Details ci/woodpecker/push/sync Pipeline was successful Details chore: Release genpass version 0.5.27		2023-01-02 06:03:33 +00:00
.github	Update FUNDING.yml	2019-09-28 09:43:52 +01:00
.woodpecker	Update '.woodpecker/publish.yml'	2023-01-02 05:48:53 +00:00
scripts	extract script to set up ci env	2023-01-01 22:26:13 +00:00
src	migrate to crane	2022-12-27 23:18:03 +00:00
tests	Add commandline tests	2020-11-28 10:27:39 +00:00
.envrc	Update dependencies	2021-09-27 14:34:47 +01:00
.gitignore	ignore nix build results	2022-12-31 08:04:49 +00:00
.gitlab-ci.yml	port to newer rust	2020-06-14 08:52:34 +01:00
CHANGELOG.md	chore: Release genpass version 0.5.27	2023-01-02 06:03:33 +00:00
Cargo.lock	chore: Release genpass version 0.5.27	2023-01-02 06:03:33 +00:00
Cargo.toml	chore: Release genpass version 0.5.27	2023-01-02 06:03:33 +00:00
LICENSE	Initial commit	2018-05-04 09:56:29 +01:00
README.md	remove sourcehut build badge	2022-12-31 10:00:57 +00:00
build.rs	port to newer rust	2020-06-14 08:52:34 +01:00
flake.lock	migrate to crane	2022-12-27 23:18:03 +00:00
flake.nix	use develop to run cargo as shell does not have the dev env	2022-12-28 13:16:52 +00:00
release.toml	don't use cargo release to push as it's broken	2022-02-12 21:17:49 +00:00
rust-toolchain	Move to moz overlay	2020-03-13 01:11:00 +00:00

README.md

genpass

A simple yet robust commandline random password generator.

Multiplatform (Linux, Mac, Windows). Fast.

You can use it generate keys or passwords in scripts or use it as your primary desktop password generator.

Has extensive generative test suite, including tests against a Rust port of Dropbox's password strength tester zxcvbn

Typical usage

genpass                  # use defaults, they're good
genpass 2048             # generate long password, can be used as a key
genpass --passphrase 128 # generate longer passphrase
genpass -dlu             # no special characters

Generating a password directly into your system clipboard

On a Mac:

genpass | pbcopy

On Linux:

genpass | xclip -selection clipboard

Getting genpass

If you're using Nix flakes

you can try genpass without installing it nix run git+https://git.cyplo.dev/cyplo/genpass.git
flake url is https://git.cyplo.dev/cyplo/genpass.git

On any system with Rust installed

$ cargo install genpass

Commandline options

$ genpass --help

USAGE:
genpass [FLAGS] [length]

FLAGS:
-h, --help                 Prints help information
-l, --include-lowercase    Generate the password using lowercase letters
-n, --include-numeric      Generate the password using numeric characters
-s, --include-special      Generate the password using special (non-alphanumeric) characters
-u, --include-uppercase    Generate the password using uppercase letters
--passphrase           Create a passphrase of (at least) the given length instead of a password.
--version

ARGS:
<length>    The length of the password to generate [default: 32]

A note on passphrases

Passphrases are generated using EFF's "long" password list.
Passphrases are at least --length characters long, not necessarily exactly that long.

A road to 1.0

TODOs to get genpass to 1.0

Contributing

All contributions welcome !

Sources

git clone https://git.cyplo.dev/cyplo/genpass.git

quickstart

you can use Nix to recreate the development environment reproducibly
nix develop in this repo will give you a shell with all the dependencies needed