localkit
v1.4.3
Published
The localkit CLI provides a series of utilities that can be used by web developers to enhance their workflow.
Downloads
32
Readme
localkit
The localkit CLI provides a series of utilities that can be used by web developers to enhance their workflow.
The modules are:
- Password: generate and analyze passwords
- Random Bytes: generate and validate Base64URL encoded sequences of random bytes
- UUID: generate and validate UUIDs (Universally Unique Identifiers)
- OTP: generate OTP (One Time Password) secrets and tokens
- AES256: encrypt and decrypt messages with the AES256 algorithm
- MD5: hash and validate messages with the MD5 Algorithm
- YoutubeDownloader: download videos/audio files from YouTube
- Favicon Builder: build all the favicon files required by modern web apps
- PWA Assets Builder: build all the assets required for a PWA to be published
- Material Icons: download and install the Material Icons on a web application
Getting Started
- Install the CLI Globally
$ npm install -g localkit
- Run it with:
$ localkit
Forking Instructions
If you wish to make use of the LocaLKit CLI to perform sensitive operations, I suggest that you fork this repository and lock all dependencies in the package.json
file (equivalent to using the --save-exact
flag) for security reasons.
Requirements
- GIT
- NodeJS ^v21.0.0
- NPM ^v10.2.0
Installation
- Clone the repository
$ git clone [email protected]:your-username/localkit.git
- Install the dependencies
$ npm install
- Run it
$ npm start
Deployment
$ npm publish
Built With
- JavaScript
Running the Tests
# Unit Tests
$ npm run test:unit
# Integration Tests
$ npm run test:integration
@TODO
[ ] Implement the JavaScript/Typescript/CSS file template generators
License
Acknowledgments
- Inquirer.js
- node-aes256
- check-password-strength
- date-fns
- generate-password
- node-md5
- uuid
- otplib
- ytdl
- sharp
- png-to-ico
- ffmpeg
- Material Design Icons