https://github.com/ZanzyTHEbar/file4you
Organize your desktop in one click
https://github.com/ZanzyTHEbar/file4you
cli executable go golang linux llm macos ollama organization productivity server windows
Last synced: about 1 year ago
JSON representation
Organize your desktop in one click
- Host: GitHub
- URL: https://github.com/ZanzyTHEbar/file4you
- Owner: ZanzyTHEbar
- License: mit
- Created: 2023-05-21T15:48:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-18T20:00:21.000Z (over 1 year ago)
- Last Synced: 2025-03-16T19:53:56.720Z (about 1 year ago)
- Topics: cli, executable, go, golang, linux, llm, macos, ollama, organization, productivity, server, windows
- Language: Go
- Homepage:
- Size: 696 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# File4You
File4You is a powerful digital filing assistant designed to streamline & optimize file management. With interactive prompting, multiple llm provider support, local-only mode, robust filtering, tagging, and more! Designed to work with you to handle all of your file-managment needs.
## Development
> [!NOTE]\
> LLM implementation is still a WIP, this ability has not been merged into main yet. Check back frequently. This is a live-updated project.
- [x] Add support for config file
- [x] Add support for custom file types
- [x] Add support for custom folders
- [x] Automatically create config file if it does not exist
- [x] Add colors to the output
- [x] Add support for subdirectories
- [x] Add support for cross-link and cross-device file manipulation
- [x] Add completions
- [x] Add git support
- [x] Add rewind support
- [x] Add workspace creation
- [ ] Add LLM Agents support
- [ ] Add tagging engine
- [ ] Add GUI
- [ ] Add installers
- [ ] Sign releases
## Usage
```bash
file4you [OPTIONS] [PATH] [OPTIONAL TARGET PATH]
```
We also support the alias
```bash
f4u [OPTIONS] [PATH] [OPTIONAL TARGET PATH]
```
### Options
All commands have alises.
```bash
completion Generate the autocompletion script for the specified shell
help Help about any command
organize Organize files in the specified directory, based on the configuration file rules
rewind Rewind the operations to an earlier state, uses git and revision sha (need git installed)
upgrade Upgrade DesktopCleaner to the latest version
version Print the version number of DesktopCleaner
```
### Arguments
```bash
PATH The path to the folder you want to clean
TARGET PATH The path you want to move everything to, then organize in the new location
```
## Installation
You can install from the releases or build from source.
> [!IMPORTANT]\
> MacOS ARM64 users will have to build from source, as I do not have a new Mx Mac to build the executable on, yet.
> If you have a Mac and would like to help, please open an issue, I will be very grateful.
> Otherwise, if you feel like supporting me, check out my Github Sponsors Page, I will be very grateful too :smile:
### Releases
> [!NOTE]\
> Releases are only available for Linux and Windows at the moment.
> [!WARNING]\
> Releases are not signed, so you will get a warning from your OS when you try to download and run the executable, this is normal and you can safely ignore it.
1. Download the latest release from [here](https://github.com/ZanzyTHEbar/file4you/releases)
2. Place the executable somewhere on your computer
3. Add the location of the executable to your PATH
### From source
> [!IMPORTANT]\
> This section of documentation is being worked on.
1. Clone the repository
2. Make sure go is installed.
```bash
make build
```
Or to build and install
```bash
make build && make install
```
To test the executable
```bash
make test
```
## List of file types
Please see the [config file](/docs/.file4you.toml) for an example.
The list of file types and their associated folders is only limited by your imagination (and the rules of your OS).
## License
[MIT](/LICENSE)