https://github.com/jmg-duarte/neat
https://github.com/jmg-duarte/neat
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jmg-duarte/neat
- Owner: jmg-duarte
- License: mit
- Created: 2020-08-04T21:22:11.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T11:08:56.000Z (almost 5 years ago)
- Last Synced: 2025-01-25T16:13:26.242Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# neat
**neat** is a CLI tool for file organization.
It is currently in its early stages and functionality is severely limited,
any suggestions are welcome, whether related to functionalities or the code itself.
## Quick History
**neat** was born out of a mix of necessity, laziness and curiosity.
My camera outputs three formats (when including video) and I wanted to divide them all into separate folders *automagically*.
At the same time, I wanted to dive in Rust and it was the perfect excuse.
## Goals
**neat** aims to be simple to use, providing both a simple interface and a configuration format.
## Usage
At its core **neat** requires one ingredient to work, a configuration,
the configuration maps the files (which are matched by globs) to the target folders.
### Configuration Example
In the example bellow we see that `mapping` is an array of dictionaries,
the motivation behind this choice is such that multiple mappings are required to exist (hence the array) and mappings are required to be flexible (so that they can be extended in the future).
```toml
[[mapping]]
folder = "JPG"
glob = "./**/*.jpg"
```
### Running Example
When running **neat**, if no configuration file is explicitly passed in (with the `-c` flag) then **neat** assumes the configuration to be present in the current directory, this file should be named `neat.toml`.
**neat** is then run against the target folder.
```
neat target_folder/
```
### Dry Run
**neat** supports dry runs (nothing is modified and changes are written to the terminal).
To perform a dry run use the `-n` or `--dry-run` flags.
### Help
For more information use `neat -h`, which outputs the following:
```
neat 0.1.1
José Duarte
USAGE:
neat [FLAGS] [OPTIONS]
ARGS:
Target folder to be organized
FLAGS:
-i Wether the globs are case sensitive or not
-n, --dry-run Run neat without applying any changes
-h, --help Prints help information
-v, --verbose Print information as neat works. Verbosity levels can be stacked by adding more v's
-V, --version Prints version information
OPTIONS:
-c, --config The path to the configuration file [default: neat.toml]
```
## Contributing & Issues
If you have a feature you'd like to see in **neat** please submit an issue.
If you'd like to contribute feel free to dive in and help!