pash/lib.rs
1//! `pash` library is a part of `pash` cli tool.
2//! It is a simple-to-use tool for generating and storing passwords
3//!
4//! ## usage:
5//! If you are using `pash` for first time, run `pash --init` in your shell. This will generate necessary files.
6//! if you wish to create new password, run `pash create`. You can specify category using `-c` or `--category flag` (`pash create yt -c social`)
7//!
8//! ## configuration:
9//! Your passwords and config are stored at `$HOME/.config/pash` (on linux) or `%APPDATA%/pash` (on windows).
10//! ### example config:
11//! ```toml
12//! lowercase = true # include lowercase characters
13//! uppercase = true
14//! symbols = true
15//! numbers = false # exclude numbers
16//! begin_with_letter = false # random first character
17//! length = 10
18//! category = "different" # default category
19//! ```
20//! > **WARNING**: passwords won't generate if you leave `length = 0`.
21
22pub mod cli;
23pub mod files;
24pub mod generator;