Skip to content

Commit

Permalink
Docs: Add logging and usage info
Browse files Browse the repository at this point in the history
  • Loading branch information
tgxn committed Jul 9, 2021
1 parent 277e90c commit 499524e
Showing 1 changed file with 14 additions and 8 deletions.
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ A CLI utility for organizing your media collections via symbolic links.
✅ Unlinks ❌ deleted files
✅ Customizable Naming Format
✅ Multiple Directory Support
✅Logging with rotation

This plugin will never move your media files, because that's your _(or your torrent client's)_ job!

Expand All @@ -40,28 +41,33 @@ npm install -g .

## Usage

```bash
```
orgMedia
run media organization
Commands:
orgMedia run run media organization [default]
orgMedia watch start media watchers [aliases: w]
Options:
--help Show help [boolean]
--version Show version number [boolean]
-c, --config Config file location
-c, --config config.json file location
[string] [default: "~/.orgMedia/config.json"]
-s, --storage Storage file location
-s, --storage storage.json file location
[string] [default: "~/.orgMedia/storage.json"]
-l, --log Log file location [default: false]
-l, --log log directory path [default: false]
-q, --quiet hide console log output [boolean] [default: false]
```

### Automatic Methods

Cron (Ragular Runs)
`orgMedia -c /path/to/config -l /path/to/log`
Cron (Regular Runs)
`orgMedia -c /path/to/config.json -l /path/to/logs/`

Watcher (Screen)
`screen -S media-watcher -d -m orgMedia watch`
Watcher/Screen _(creates a screen named `media_watcher` watching your media)_
`screen -S media_watcher -dm orgMedia watch -c config.json -l ./logs/`

## Configuration

Expand Down

0 comments on commit 499524e

Please sign in to comment.