README
¶
Fairu
Maintain your work directory with Fairu.
Fairu is a tool to help you keep your file system ordered, based on a simple system of rules.
WARNING: This is an experimental tool, so use it with great care, I do not make myself responsible for any loss of data caused by the use of this utility.
Installation
Execute the follow command: go install -ldflags='-w -s' github.com/anderson-lt/fairu/cmd/fairu@latest.
Get Started
Copy the following to the program configuration path:
Rules:
Skip Hidden:
Type: hidden
Skip Directory:
Type: directory
Show Big Files:
Type: regular file
Size: 50MB
Say: Big file $ShellPath
Files With Extension:
Glob: "*.*"
Say: Has extension $Extension the file $ShellPath
Rest Of Files:
Say: File $ShellPath
Run the program without arguments the first time to see the configuration file path.
Then execute the fairu command to see the program in action.
Documentation
As explained below, the program is in an early development phase, so everything can change overnight and without prior notice.
The documentation of the configuration file (incomplete) is here.
State
This program is at a very early stage of development and therefore it is very unstable.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package action contains the type Action and some basic actions.
|
Package action contains the type Action and some basic actions. |
|
cmd
|
|
|
Package config provides access to Fairu configuration file.
|
Package config provides access to Fairu configuration file. |
|
Package filter contains filters for the filesystem.
|
Package filter contains filters for the filesystem. |