Skip to content

Commit f33eb23

Browse files
Update readme and fix version
1 parent 57585e9 commit f33eb23

File tree

4 files changed

+42
-27
lines changed

4 files changed

+42
-27
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "messy-folder-reorganizer-ai"
3-
version = "0.1.0"
3+
version = "0.1.8"
44
edition = "2021"
55
authors = ["Eugene Perminov <perminov.eugene@gmail.com>"]
66
license = "MIT OR Apache-2.0"

README.md

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,30 +35,52 @@ Before using this application, you need to install the following dependencies:
3535

3636
4. Download latest release
3737

38-
```sh
39-
curl -s https://api.github.com/repos/PerminovEugene/messy-folder-reorganizer-ai/releases/latest | \
40-
grep "browser_download_url.*messy-folder-reorganizer-ai-aarch64-apple-darwin.tar.gz" | \
41-
cut -d '"' -f 4 | \
42-
xargs curl -L -o messy-folder-reorganizer-ai-macos.tar.gz
43-
```
38+
```sh
39+
curl -s https://api.github.com/repos/PerminovEugene/messy-folder-reorganizer-ai/releases/latest | \
40+
grep "browser_download_url.*messy-folder-reorganizer-ai-aarch64-apple-darwin.tar.gz" | \
41+
cut -d '"' -f 4 | \
42+
xargs curl -L -o messy-folder-reorganizer-ai-macos.tar.gz
43+
```
4444

4545
5. Extract the file
4646

47-
```sh
48-
tar -xvzf messy-folder-reorganizer-ai-macos.tar.gz
49-
```
47+
```sh
48+
tar -xvzf messy-folder-reorganizer-ai-macos.tar.gz
49+
```
5050

5151
6. Move to `/usr/local/bin` for system-wide use
5252

53-
```sh
54-
sudo mv messy-folder-reorganizer-ai /usr/local/bin/messy-folder-reorganizer-ai
55-
```
53+
```sh
54+
sudo mv messy-folder-reorganizer-ai /usr/local/bin/messy-folder-reorganizer-ai
55+
```
5656

5757
7. Verify installation
5858

59-
```sh
60-
messy-folder-reorganizer-ai --help
61-
```
59+
```sh
60+
messy-folder-reorganizer-ai --help
61+
```
62+
63+
### Build from sources
64+
65+
If you want to build it from sources by yourself:
66+
67+
1. Pull repository
68+
69+
```sh
70+
git clone git@github.com:PerminovEugene/messy-folder-reorganizer-ai.git
71+
```
72+
73+
2. Build project with
74+
75+
```sh
76+
cargo build --release
77+
```
78+
79+
3. Launch with
80+
81+
```sh
82+
cargo run -- -M deepseek-r1:latest --show-ai-thinking --path ./../../Documents/ -S
83+
```
6284

6385
## Usage
6486

@@ -85,16 +107,11 @@ The application provides several command-line flags to configure its behavior. B
85107
| `--server-address` | `-n` | `http://localhost:11434/api/generate` | Overrides the default LLM server address. |
86108
| `--skip-problematic-dir` | `-d` | `false` | Will skip problematic directories and files. |
87109

88-
### Example Usage
89-
90-
If you want to use it globally, while it's not published:
91-
92-
1. build with `cargo build --release`
93-
2. `sudo mv target/release/messy-folder-reorganizer-ai /usr/local/bin/messy-folder-reorganizer-ai`
110+
### Usage examples
94111

95112
```sh
96113
# Basic usage
97-
messy-folder-reorganizer-ai --model deepseek-r1:latest --path ./documents
114+
messy-folder-reorganizer-ai -M deepseek-r1:latest -P ./../../Downloads -S -A
98115

99116
# Enable recursive processing and show AI thinking details
100117
messy-folder-reorganizer-ai --model deepseek-r1:latest --path ./documents --recursive --show-ai-thinking
@@ -143,8 +160,6 @@ rm -rf ~/.messy-folder-reorganizer-ai
143160

144161
## TODO
145162

146-
- Release.
147-
148163
### Next releases debt and ideas
149164

150165
- Multiple AI requests for result improvements.
@@ -156,6 +171,7 @@ rm -rf ~/.messy-folder-reorganizer-ai
156171
- Improve error handling.
157172
- Add tests.
158173
- Update rust version.
174+
- Enable cross platform builds if somebody will be interested
159175

160176
### Refactoring ideas
161177

src/configuration/init.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ use std::path::{Path, PathBuf};
55
use crate::configuration::consts::{
66
CONFIGURATION_FILE, CONFIGURATION_FOLDER, INITIAL_PROMPT_FILE, PROMPTS_FOLDER,
77
};
8-
// Make sure you can access the embedded constants (either inline or in another mod)
98
use crate::configuration::embedded_assets::{CONFIG_FILE_BYTES, INITIAL_PROMPT_FILE_BYTES};
109

1110
pub fn init() {

0 commit comments

Comments
 (0)