rustag 0.1.0

Rustag, a Rust-built command-line tool, simplifies file organization through custom tagging and swift fuzzy search, enhancing file management directly from your terminal.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

# Rustag

Rustag is a Rust-based command-line tool for organizing and tagging files on your system. It allows users to tag files with custom labels and retrieve them easily using a fuzzy search interface.

## Features

- **File Tagging**: Assign custom tags to your files for easy organization.
- **Fuzzy Search**: Easily find your files using a fuzzy search interface.
- **File Management**: Open files or their containing folders directly from the command line.

## Installation

To install Rustag, ensure you have Rust and Cargo installed on your system.
Then run the following command:

```bash
cargo install rustag
```

And for additional features, add the following to your `~/.bashrc` or `~/.zshrc`:

```bash
rtg() {
  RUSTAG=$(rustag $@)
  
  # RUSTAG contains "Error" then just print else cd $(RUSTAG)
  if [[ $RUSTAG == *"Error"* ]]; then
    echo $RUSTAG
  else
    cd $RUSTAG
  fi
}
```

Then run `rtg` to get started.

## Setup

Upon first run, Rustag will create a `.rustag` directory in your home folder to store its data. This includes a `tagfile` that maintains the tag information.

## Usage

### Tagging a File

To tag a file, run Rustag with the file name as an argument:

```bash
rtg filename.ext
```

Follow the prompts to select existing tags or create a new one.

### Retrieving Files

To view and open files associated with a tag:

1. Run Rustag without any arguments.
2. Select a tag from the list.
3. Choose a file to open or a related action.

## Data Structure

Rustag uses several custom data structures:

- `AGFile`: Represents a tagged file, including metadata such as creation date and file path.
- `AGTag`: Represents a tag, associated with multiple `AGFile` instances.
- `AGTagList`: Manages the collection of tags and their associated files.

## Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.