sshhh
v1.2.0
Published
A command line tool to generate random secret keys
Downloads
102
Maintainers
Readme
Table of Contents
About The Project
I've had a need for quickly creating secrets for various use cases, for example, creating a secret for a new API key or a JWT secret. I've always used online tools or NodeJS, but I wanted a simple command line tool that I could use to create secrets for any use case.
(Icon by Freepik)
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Install the package globally with:
npm i -g sshhh
Then run the command to generate a secret:
sshhh
Usage
By default, the command will generate a 256 byte secret encoded in Base64. You can change the length of the secret with the -l
or --length
flag. You can also change the encoding with the -t
or --type
flag.
The -l
or --length
flag accepts a number between 4 and 268,435,456 (this is due to the maximum string possible in JavaScript).
The -t
or --type
flag accepts the following values: base64
, hex
, base64url
.
The -c
or --clipboard
flag copies the key to your system's clipboard.
The -ch
or --clipboard_hide
flag copies the key to your system's clipboard and hides the key.
The -std
or --std
flag removes all unneccessary logs. Useful for piping.
Example: For a 512 byte secret encoded in hex:
sshhh -l 512 -t hex
For more help type:
sshhh --help
Releases
See the releases page for all releases and to download the binaries.
Roadmap
See the open issues for a list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the GNU General Public License v3.0 License. See LICENSE
for more information.
Contact
Jack Humphries - [email protected]
Project Link: https://github.com/JackHumphries9/sshhh