Skip to content

JoseLu-Dev/fizard

Repository files navigation

Contributors Forks Stargazers Issues


fizard

A cli program to manage files and folders

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. Contact

About The Project

I just wanted to make a cli program to manage files while challenging myself and learning in the proccess.

(back to top)

Built With


(back to top)

Getting Started

Prerequisites

Installation

  1. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  2. Install NPM packages
    npm install
  3. Install package globally
    npm run install-global

(back to top)

Usage

To see program help menu:

   fizard -h

You can also see help for each individual command:

   fizard help structure

or

   fizard structure -h

(back to top)

Roadmap

  • Add Changelog
  • Add command to find duplicate files
  • Add option to see a command historic
  • Add command to revert previous commands

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

JoseLu - joseludev@gmail.com

Project Link: https://github.com/JoseLu-Dev/fizard

(back to top)

About

A cli program to manage files and folders

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •