File Foundry CLI

The File Foundry CLI is your ultimate companion for managing and organizing files on your media server. Whether you're dealing with a colossal collection of movies, TV shows, or a vast array of digital media, this command-line tool is designed to make your life easier.

Usage

$ npm install -g file-foundry-cli
$ ffc COMMAND
running command...
$ ffc (--version)
file-foundry-cli/0.0.0 darwin-arm64 node-v18.18.0
$ ffc --help [COMMAND]
USAGE
  $ ffc COMMAND
...

Getting Started

Ready to forge your media server files into perfect shape? Follow these steps to get started:

Installation: Start by installing the File Foundry CLI using npm:
```
npm install -g file-foundry-cli
```
Configuration: Before you begin organizing your files, you'll need to configure the tool with the paths to your media server directories:
```
file-foundry-cli configure
```
This command will guide you through the setup process, ensuring that the CLI knows where to find your files.
Usage: Now you're all set! You can start using the File Foundry CLI to manage and organize your media server files. For example:
- To organize your media files:
```
file-foundry-cli organize
```
- To perform other tasks, explore the CLI's various commands and options in the Documentation.
Enjoy: Sit back and let the File Foundry CLI do the heavy lifting. Your media server will be more organized than ever before!

Backstory

Imagine this: a sprawling media server packed to the brim with gigabytes (or even terabytes) of digital treasures. You've spent countless hours curating your collection, ensuring that every file is properly named and organized. But the more you collect, the harder it becomes to keep things tidy. That's where the File Foundry CLI comes in.

The journey to creating this tool began with a familiar tale. Frustration mounted as Colten grappled with a hodgepodge of messy files and buggy bash scripts. It was clear that a more powerful, flexible, and user-friendly solution was needed. So, the File Foundry CLI was born!

What's in a Name?

File: Because, well, it's all about files!
Foundry: A place of creation and transformation. Your files will be reshaped and molded as you see fit.
CLI: The Command-Line Interface that empowers you to take control of your media server files like a pro.

Powered by OCLIF

The File Foundry CLI is proudly built on top of the OCLIF framework, a powerful foundation for creating command-line interfaces. This framework ensures that you get a robust and consistent experience while using our tool.

Collaborate and Contribute

We believe that great tools are built collaboratively. We invite you to join us in enhancing the File Foundry CLI. Whether it's adding new features, fixing bugs, or improving documentation, your contributions are invaluable.

Credit

Thanks for the assist from GPT-4 in research and setting this up.

License

The File Foundry CLI is open-source and released under the MIT License. Feel free to use it, modify it, and share it with fellow media server enthusiasts.

Happy file organizing!

coltenkrauter/file-foundry-cli