# file-date-organizer

> Move files into a folder structure organized by date.

Latest version **0.9.0** (published 2020-06-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install file-date-organizer
pnpm add file-date-organizer
yarn add file-date-organizer
bun add file-date-organizer
```

Provides the command `file-date-organizer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.0 |
| Published | 2020-06-04 |
| First published | 2020-06-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 635.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Fred Lackey |
| Maintainers | fredlackey |
| Keywords | sed, awk, lines, replace |

## Links

- npm: https://www.npmjs.com/package/file-date-organizer
- Repository: https://github.com/FredLackey/file-date-organizer
- Homepage: https://github.com/FredLackey/file-date-organizer#readme
- Issues: https://github.com/FredLackey/file-date-organizer/issues
- npm.io page: https://npm.io/package/file-date-organizer

## Dependencies (2)

- [yargs](https://npm.io/package/yargs.md) ^15.3.1
- [@fredlackey/ugly-date](https://npm.io/package/@fredlackey/ugly-date.md) ^0.8.0

## Recent versions

- 0.9.0 (latest) — 2020-06-04
- 0.8.3 — 2020-06-04
- 0.8.2 — 2020-06-03
- 0.8.1 — 2020-06-03
- 0.8.0 — 2020-06-03
- 0.7.4 — 2020-06-03
- 0.7.3 — 2020-06-03
- 0.7.2 — 2020-06-02
- 0.7.1 — 2020-06-02
- 0.7.0 — 2020-06-02
- 0.6.0 — 2020-06-02

## README

# File Date Organizer for NodeJS

>  The following document applies to the command-line usage of `file-date-organizer`.  For usage directly in a Node application, please see the [alternate README located here](README-ALT.md).

## Purpose  
Locate files by date and move them into a date-based folder structure (ie `.../YYYY/MM/dd/hh`, etc.).  Dates are extracted from the file name (ie `Screen Shot 2020-05-28 at 10.16.59 AM.png`) or the file properties (created date, modified date, etc.).

> More info on _why_ I created this is on my blog: [https://fredlackey.com](https://www.fredlackey.com)

## Installation

```
npm i -g file-date-organizer
```

## Usage
Exatract then date from the _name_ of the file ... 
```
file-date-organizer \
  --source "/Users/flackey/Documents/Screenshots" \
  --target "/Volumes/MPHD01/Screenshots" \
  --use-name \
  --move \
  --recursive \
  --overwrite
```
... or, use a _file property_, such as the creation date ... 
```
file-date-organizer \
  --source "/Users/flackey/Documents/Screenshots" \
  --target "/Volumes/MPHD01/Screenshots" \
  --use-created \
  --move \
  --recursive \
  --overwrite
```
When I process images from my camera, I use _both_ the `--use-name` switch as well as `--use-created`.  This ensures files without a date in the name still get moved properly.
```
file-date-organizer \
  --source '/Users/flackey/pCloud Drive/Automatic Upload/' \
  --target /Volumes/MPHD01/Multimedia/Photos/ \
  --move \
  --use-name \
  --use-created \
  --recursive \
  --overwrite \
  --console
```
The addition of the `--console` switch adds an output which is helpful for long-running operations...

![Console Output](./docs/images/console-output.png)

> **Important:**  
> Combining `--use-name` and any other `--use*` option will cuase `--use-name` to be leveraged first.  If a valid name can be found within the name then the properties of the file will be ignored.

### Parameters

| Name           | Description                              | Type            | Default |
|----------------|------------------------------------------|-----------------|---------|
| `source`       | Source Directory                         | `string (path)` |         |
| `target`       | Desination Directory                     | `string (path)` |         |
| `recursive`    | Locate files recursively                 | `boolean`       | `true`  |
| `overwrite`    | Overwrite existing target files          | `boolean`       | `false` |
| `ignore`       | Ignore existing target files             | `boolean`       | `false` |
| `copy`         | Copy the files                           | `boolean`       | `false` |
| `move`         | Move the files                           | `boolean`       | `false` |
| `use-name`     | Extract date from file name              | `boolean`       | `false` |
| `use-created`  | Use created date for target folder name  | `boolean`       | `false` |
| `use-modified` | Use modified date for target folder name | `boolean`       | `false` |
| `add-type`     | Target folder name includes file type    | `boolean`       | `false` |
| `add-year`     | Target folder name includes file year    | `boolean`       | `true`  |
| `add-month`    | Target folder name includes file month   | `boolean`       | `true`  |
| `add-day`      | Target folder name includes file day     | `boolean`       | `true`  |
| `add-hour`     | Target folder name includes file hour    | `boolean`       | `false` |
| `add-minute`   | Target folder name includes file minute  | `boolean`       | `false` |
| `add-second`   | Target folder name includes file second  | `boolean`       | `false` |
| `console`      | Log activity to console                  | `boolean`       | `false` |
| `limit`        | Number of files to process               | `number`        |         |
| `allow-future` | Allow file names with date in future     | `boolean`       | `false` |

### Contact  
Please feel free to contact me directly with any questions, comments, or enhancement requests:

**Fred Lackey**  
**[fred.lackey@gmail.com](mailto://fred.lackey@gmail.com)**  
**[http://fredlackey.com](http://www.fredlackey.com)**

---
_Source: https://npm.io/package/file-date-organizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._