filerica

CLI for easy file classification

Usage no npm install needed!

<script type="module">
  import filerica from 'https://cdn.skypack.dev/filerica';
</script>

README

Filerica

日本語

logo

npm node.js npm GitHub issues GitHub forks GitHub stars GitHub license Twitter

Isn't it time to organize your cluttered files?

Highlight

  • CLI for easy file classification

  • Execute with a single command

  • Especially recommended for students

Requirement

Node version 16.x or higher is required.

Install

npm install -g filerica

Usage

  1. npx filerica i [inputPath]

    If you are launching Filerica for the first time, please set input-path. Filerica will classify the files in the directory specified in input-path.

  2. npx filerica b [boardName, boardPath] --s

    Next, create a board. A board is a directory for classification. --s option allows you to select the board as you create it.

  3. npx filerica e

    Now, let me describe the rules for classification. The name of the file to be classified is "class_name number file_name", such as "Math week8 doc.pdf". When you run the classification, a directory named "8" will be made inside the directory "Math" in board, and the files will be moved there. However, you need to make a "Math" directory in board beforehand.

Commands

  • execute(alias: e)

    Execute classification. The input-path and board must be specified.

  • input [inputPath](alias: i)

    Change input-path.

  • board [name, path](alias: b)

    Register a board.

    Options
    • --s: Select as well as create
    • -sp [separator]: Specify the separator
    • --rm: Remove a board
    • --l: Display boards list

  • select(alias: s)

    Select a board.

    Options
    • -n [name]: Specifies the name of the board directly

  • separator [separator](alias: sp)

    Change the separator for the currently selected board. The default is blank space. For example, if you specify "_", the file name rule will be "Math_week8_doc.pdf".

    Options
    • --rs: Resets the separator to the default blank space

  • language(alias: l)

    Change language. 日本のユーザは、まずは日本語に変更することをお勧めします。:jp:

Issues

If you find a bug or problem, please open an issue!:bug:

Author

LICENSE

This project is licensed under the MIT License - see the LICENSE file for details.