README

RyPass - Password Generator

Description

RyPass is a Terminal-based application that generates and stores passwords for multiple usernames on different accounts. All sensitive information is stored locally and can be accessed anytime using basic RyPass terminal commands.

To utilize the same password generation, encryption and decryption logic in your Ruby project, be sure to checkout the gem Passr.

Setup

• Clone down this repository.
• cd into the rypass directory and run ./config/install.sh
• You may have to enter your sudo password to install RyPass into /usr/local/bin
• Once the installation is complete, you can run any RyPass commands from the terminal using rypass.

Contributing

RyPass is always looking for open source contributors to help its growth, reliability and performance. We welcome coders of all levels to help out and add to our codebase.

To find out more about how you can contribute please read our contributing guide and for specific functionality check out our documentation.

RyPass Operation

Commands

• new or n - Generate a password for an account and username attached to that account.
  • Flags:
    • --account= or -a - Name of account
    • --username= or -u - Name of username
    • --destination= or -d - Path of destination for csv -- If no path is given, the data will be saved to the default location of ~/Library/RyPass
    • --length= or -l - Length of generated password (12 character default)
• generate or g - Generates a random password and displays it. Password is not attached to an account, username, or saved in the system.
  • Flags:
    • --length= or -l - Length of generated password (12 character default)
• account or a - Displays usernames and passwords attached to account.
  • Secondary Actions:
    • -A or --all displays all usernames and passwords.
    • -U or --usernames displays only usernames attached to account.
    • -P or --get-password displays password for given username in account.
  • Flags:
    • --account= or -a - Name of account
    • --username= or -u - Name of username
• export or e - Exports all accounts, including usernames and passwords, to a given path.
  • Flags:
    • --path= or -p - Path of RyPass data -- If no path is given, the data will be searched for in the default location of ~/Library/RyPass
    • --destination= or -d - Destination for the exported RyPass data.
• commands or c - Display list of all RyPass commands and functions.
• uninstall or U - Uninstall RyPass. All csvs and data will NOT be deleted and will still be accessible in the given directory.