Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jjuliano/aifiles
A CLI that organize and manage your files using AI
https://github.com/jjuliano/aifiles
Last synced: about 2 months ago
JSON representation
A CLI that organize and manage your files using AI
- Host: GitHub
- URL: https://github.com/jjuliano/aifiles
- Owner: jjuliano
- License: other
- Created: 2023-02-24T23:59:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:07:52.000Z (about 2 months ago)
- Last Synced: 2024-07-29T15:29:08.854Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/aifiles
- Size: 5.35 MB
- Stars: 156
- Watchers: 6
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-chatgpt - aifiles - Organize and manage your files using AI. (CLI tools / Examples)
- awesome-chatgpt - aifiles - Organize and manage your files using AI. (CLI tools / Examples)
README
🤖 AI Files
A CLI that helps you organize and manage your files using AI.
⚠️ This app uses ChatGPT 🤖, which could raise privacy concerns. Please be cautious when sharing personal information.🔒
# Installation
To install AI Files, simply run:
```
npm install aifiles
```
You will also need to install the following dependencies:
- [https://pandoc.org/](pandoc)
- [https://exiftool.org/](exiftool)
- [https://poppler.freedesktop.org/](pdftotext) (included via poppler)
- [https://csvkit.readthedocs.io/en/latest/](in2csv) (included via csvkit)
Copy-and-paste version:
```
brew install pandoc exiftool poppler csvkit
```
# Usage
To use AI Files, copy the `.aifiles` and `.aifiles.json` files to your home directory.
```
mkdir git
cd ~/git
git clone https://github.com/jjuliano/aifiles.git
cp aifiles/.aifiles.sample ~/.aifiles
cp aifiles/.aifiles.json ~/.aifiles.json
```
You would need to modify the ~/.aifiles and add your `OPENAI_API_KEY` and `REPLICATE_API_KEY` (for audio/video captioning).
Then, run:
```
aifiles [filename]
```
where filename is the name of the file you want to process.
# Features
## AI Files can:
- Organize audio, video, pictures, documents, archives, and other types of files
- Automatically extract relevant information from your files using OpenAI ChatGPT.
- Automatically add tag and comments to the file
- Organize your files into categories and directories based on their content
- Rename your files using a [customizable naming convention](https://github.com/jjuliano/aifiles/blob/main/.aifiles.sample#L28)
- Store your files in a designated directory
# TODO
- [See issue #9](https://github.com/jjuliano/aifiles/issues/9)
# Contributions
Contributions are welcome! Feel free to open issues and pull requests on GitHub.
# License
This project is licensed under the MIT License.