<commit_before>Password, Please!
=================

> **Password, Please!** generates secure passwords in PHP. You can use it as a command line application or as a library in your code.

[![Build Status](https://travis-ci.org/florianeckerstorfer/passwordplease-php.svg?branch=master)](https://travis-ci.org/florianeckerstorfer/passwordplease-php)


Command Line Application
------------------------

Downloading the PHAR archive from the [releases page](https://github.com/florianeckerstorfer/passwordplease-php/releases) page is the easiest way to get the command line application.
The other way is to clone this repository and execute the `bin/password-please.php` file.

```shell
$ git clone https://github.com/florianeckerstorfer/passwordplease-php
$ cd password-please-php
$ php bin/password-please.php gen
```

### Usage

If you call the binary without any arguments you will get a password of length 20 with lower and upper case letters,
numbers and special characters. You can change both the length and the complexity.

```shell
$ php password-please.phar gen --length=30 --complexity=3
```

The length must be greather than `0` and complexity must be a value between `1` (low complexity) and `4`
(very high complexity). If you're a hasty person, you can use the shorter aliases for the options:<commit_msg>Fix description of complexity in README<commit_after>Password, Please!
=================

> **Password, Please!** generates secure passwords in PHP. You can use it as a command line application or as a library in your code.

[![Build Status](https://travis-ci.org/florianeckerstorfer/passwordplease-php.svg?branch=master)](https://travis-ci.org/florianeckerstorfer/passwordplease-php)


Command Line Application
------------------------

Downloading the PHAR archive from the [releases page](https://github.com/florianeckerstorfer/passwordplease-php/releases) page is the easiest way to get the command line application.
The other way is to clone this repository and execute the `bin/password-please.php` file.

```shell
$ git clone https://github.com/florianeckerstorfer/passwordplease-php
$ cd password-please-php
$ php bin/password-please.php gen
```

### Usage

If you call the binary without any arguments you will get a password of length 20 with lower and upper case letters,
numbers and special characters. You can change both the length and the complexity.

```shell
$ php password-please.phar gen --length=30 --complexity=3
```

The length must be greather than `0` and complexity must be a value between `1` (very high complexity) and `4`
(low complexity). If you're a hasty person, you can use the shorter aliases for the options:
{'fraction_non_alphanumeric': 0.11888638073739653, 'fraction_numerical': 0.006019563581640331, 'mean_word_length': 4.448770491803279, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1932453', 'n_tokens_mistral': 767, 'n_tokens_neox': 714, 'n_words': 302}