Skip to content
Christian Galo edited this page Mar 14, 2022 · 2 revisions

Welcome to the file-organizer docs!

NOTE: I probably won't touch this repo until mid April 2022, just fyi.

Roadmap to version 0.1.0

Am currently brainstorming what I need from file-organizer. Here are some things that come to mind:

  • Ability to organize a specified directory and its subdirectories as specified in a specification document.
    • Not sure what a specification document would look like yet, but it will likely be something like YAML or something else.
    • No, I don't expect everybody to come up with their own specifications. I hope to also provide a set of standard specification documents.
  • Ability to organize files according to file metadata.
    • Don't know enough about how each type of file manages metadata, but filorg should be able to extract exif data from photos, frontmatter yaml from markdown, etc.
  • Ability to acknowledge versioned directories and warn against reorganizing them.
  • Warn when directories are out of compliance with a given specification
    • point out where the directory organization is at fault
    • suggest and be able to organize the directory if set to do so.

Commands:

  • filorg organize SPECIFICATION PATH
Clone this wiki locally