@gnosec/pw

1.0.0-rc1 • Public • Published

Build Status dependencies Status devDependencies Status Coverage Status NSP Status

PW

A simple and intuitive cross-platform command-line password manager.

Usage

$ pw --help

  Usage: pw <file>

  Options:

    -V, --version  output the version number
    -h, --help     output usage information

$ pw passwords-file
? File "passwords-file" does not exist. Do you want to create it? Yes
? Create master password: [hidden]
? Confirm master password: [hidden]
password-file$ help

  Commands:

    help [command...]        Provides help for a given command.
    exit                     Exits application.
    change-master-password   Changes the master password of the file
    cp <key> <newKey>        Copies a key-value pair
    echo <key> [index]       Prints the value for the given key
    export                   Copies all password safe data to the clipboard in JSON format
    gen [options] [key]      Generates a password and copies it to the clipboard. If a key is provided, the password will be stored as the value of that key.
    get <key> [index]        Copies the value of the given key to the clipboard
    history <key>            Prints all historical values for a given key and the date and time they were entered
    ls [search]              Prints all keys alphabetically and filtered by the search word
    mv <key> <newKey>        Renames a key
    rm <key>                 Removes a key value pair
    set <key> [value]        Sets a key-value pair. The value will be prompted for if not provided
    tree [search]            Prints all keys alphabetically in a tree format and filters them the search word

passwords-file$ gen mybank.password
passwords-file$ echo mybank.password
c*U6FbTqVELRPaB!%sFf.2~LIOn[;ori'

Commands under consideration

  1. Save command
  2. Undo command
  3. Custom cryptography algorithm option on invocation "pw --algorithm AES my-passwords"

Installation

# Download code
git clone git@github.com/gnosec/pw
cd pw

# Build from source
npm run build

# Mac OS
mv bin/pw-macos /usr/local/bin/pw

# Linux
echo "export PATH=\$PATH:/pw/parent/dir" >> ~/.bashrc && source ~/.bashrc

# Windows
setx path "%path%;pw/parent/dir"

Development

Prerequisites

  1. node.js/npm
  2. typescript + ts-node
npm install -g typescript ts-node

Set up for continuous development

git clone git@github.com/gnosec/pw
cd pw
npm install && npm link
pw

Readme

Keywords

none

Package Sidebar

Install

npm i @gnosec/pw

Weekly Downloads

6

Version

1.0.0-rc1

License

GPL-3.0-only

Unpacked Size

109 kB

Total Files

51

Last publish

Collaborators

  • gnosec