<commit_before>cvault
======

Credential Vault (cvault) is a place where you can save your memory about credentials, e.g. account and password, along with some helpful description.


Installation
------------

Run the installer script to install dependencies and the cvault program.

~~~ sh
$ ./install.sh
~~~

Then initialize the vault (database).

~~~ sh
$ cvault init </path/to/vault>
~~~


Usage
-----

There are two modes in cvault:

1. interactive mode: cvault will open up a dialog, and you can interact with it
2. non-interactive mode: saves entry with one shot, no more dialog

### Interactive Mode

~~~ sh
$ cvault
~~~

And follow the instructions to achive the goal.

### Non-interactive Mode

~~~ sh
$ cvault --save --account <account> --password <password> --description <description> # save a new entry
$ cvault --remove <id> # remove certain entry
$ cvault --list # list all the entries reside in the vault
$ cvault --show <id> # show the exact entry
$ cvault --search --account <account> # with exact account name
$ cvault --search --description <pattern> # pattern searching in description
~~~<commit_msg>Modify usage<commit_after>cvault
======

Credential Vault (cvault) is a place where you can save your memory about credentials, e.g. account and password, along with some helpful description.


Installation
------------

Run the installer script to install dependencies and the cvault program.

~~~ sh
$ ./install.sh
~~~

Then initialize the vault (database).

~~~ sh
$ cvault init </path/to/vault>
~~~


Usage
-----

There are two modes in cvault:

1. interactive mode: cvault will open up a dialog, and you can interact with it
2. non-interactive mode: saves entry with one shot, no more dialog

### Interactive Mode

~~~ sh
$ cvault
~~~

And follow the instructions to achive the goal.

### Non-interactive Mode

~~~ sh
$ ./cvault.py save -a <account> -p<password> -d <description> # save a new entry
$ ./cvault.py remove <id> # remove certain entry
$ ./cvault.py list # list all the entries reside in the vault
$ ./cvault.py show <id> # show the exact entry
$ ./cvault.py search -a <account> # with exact account name
$ ./cvault.py search -d <pattern> # pattern searching in description
~~~
{'fraction_non_alphanumeric': 0.12319494584837545, 'fraction_numerical': 0.0018050541516245488, 'mean_word_length': 3.524489795918367, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2780172', 'n_tokens_mistral': 653, 'n_tokens_neox': 624, 'n_words': 292}