Skip to content

Latest commit

 

History

History
183 lines (120 loc) · 3.44 KB

README.md

File metadata and controls

183 lines (120 loc) · 3.44 KB
Raw



Zen


@ritikchoure/zen

Zen is command line tool to provide complete file system to access, delete, create, rename your files and so on...

GitHub license Maintainer

Table of contents

  1. Installation
  2. CLI Usage
    1. Create File
    2. Create Folder/Directory
    3. Rename File/Folder
    4. Remove File/Folder
    5. Check File/Folder Existence
    6. Read File
    7. Read Directory
    8. Create Zip
    9. Create Local Server
    10. Create & Download QR Code
    11. Check Version
    12. Get Help
  3. Authors
  4. Feedback
  5. License
  6. Tech Stack

Installation

npm i -g @ritikchoure/zen

make sure you install it globally.

To check successfull installation of zen, open command prompt or windows terminal.

Type in your cmd -

zen --version

CLI Usage

Create File

Using the following command, you can create files -

zen -f filename.extension

Create Folders/Directory

Using the following command, you can create folders/directory -

zen -dir foldername

Rename File/Folder

Using the following command, you can rename file/folder -

zen -rn oldfilename newfilename

Remove File/Folder

Using the following command, you can remove file/folder -

zen -rm filename/foldername

Check File/Folder Existence

Using the following command, you can check existence of any file/folder -

zen -e filename/foldername

Read File

Using the following command, you can read contents of the file in utf-8 encoding -

zen -rf filename

Read Directory

Using the following command, it will show the full list or content of your directory.

zen -rd

Create Zip

Using the following command, it will create a zip file of the given file.

zen -zip filename

Create Local Server

Using the following command, it will create a local server with 8080 as default port and host index.html, if index.html is exists in the current working directory.

We can use the custom port to listen on the server.

default

zen -serve

Custom port

zen -serve -p portnumber

Create & Download QR Code

Using the following command, you can create and download QR code image in your current working directory

zen -qr <url>

Check Version

Using the following command, you can check version of zen -

zen -v

or

zen --version

Get Help

Using the following command, you can check available commands of zen -

zen --help

Authors

Feedback

If you have any feedback/queries, please reach out to us at ritvikchoure65@gmail.com

License

MIT

Tech Stack

Node, FS,