hush

hush: Secure CLI Password Manager

hush is a command-line interface (CLI) password manager designed for security and ease of use.

• Installation
• Security Features
• Commands
• Usage Example
• Contributing
• Support

Installation

Prerequisites

• Go 1.16 or later
• Make (for Make installation method)

Installing with Make

1. Clone the repository:

   git clone https://github.com/nochzato/hush.git
   

2. Navigate to the project directory:

   cd hush
   

3. Run the make install command:

   make install
   

This will build the project and install the hush binary in /usr/local/bin/.

Installing from Source

1. Clone the repository:

   git clone https://github.com/nochzato/hush.git
   

2. Navigate to the project directory:

   cd hush
   

3. Build the project:

   go build -o hush cmd/hush/main.go
   

4. (Optional) Move the binary to a directory in your PATH for easy access:

   sudo mv hush /usr/local/bin/
   

Using Go Install

If you have Go installed and configured, you can install hush directly using:

go install github.com/nochzato/hush/cmd/hush@latest

This will download, compile, and install the hush binary in your $GOPATH/bin directory.

Verifying Installation

After installation, verify that hush is installed correctly:

hush version

This should display the version of hush you've installed.

Security Features

• Master Password: Single point of access for all stored passwords
• Argon2 Key Derivation: Robust key derivation from the master password
• AES-GCM Encryption: State-of-the-art encryption for stored passwords
• Secure Storage: Encrypted passwords stored locally with restricted access

Commands

Display Version

hush version

Show the current version of hush.

Initialize Hush

hush init

Set up hush and create your master password.

Add a Password

hush add <password-name>

Store a new password entry.

List Passwords

hush list

Display all stored password names.

Retrieve a Password

hush get <password-name> [flags]

Fetch a stored password.

Flags:

• -d, --display: Display the password instead of copying to clipboard

By default, the password is copied to the clipboard for security.

Remove a Password

hush remove <password-name>

Delete a stored password.

Generate a Password

hush generate [flags]

Create a strong, random password.

Flags:

• -l, --length <number>: Specify the length of the generated password (default: 16)
• -d, --display: Display the generated password instead of copying to clipboard

By default, the generated password is copied to the clipboard for convenience.

Delete All Data

hush implode

Remove all stored data and the hush directory.

Usage Example

$ hush init
Enter your master password: ********
Hush initialized successfully!

$ hush generate -l 16 -d
Generated password: P@ssw0rd!2345678
Password copied to clipboard.
Do you want to save this password? (y/N): y
Enter a name for this password: example_password

$ hush list
example_password

$ hush get example_password
Enter your master password: ********
Password copied to clipboard.

$ hush remove example_password
Enter your master password: ********
Password removed successfully.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you find Hush useful, please consider giving this repository a star ⭐. Your support helps to increase the visibility of this project and is greatly appreciated!