rustag 0.2.1

Rustag, a Rust-built command-line tool for bookmarking directories with custom aliases and fuzzy search.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

# Rustag

Rustag is a Rust-based command-line tool for bookmarking directories on your system. It allows users to assign custom aliases to directories and navigate to them easily using a fuzzy search interface.

## Features

- **Directory Bookmarking**: Assign custom aliases to your directories for easy organization.
- **Fuzzy Search**: Easily find your bookmarks using a fuzzy search interface with alias and path displayed together.
- **Directory Navigation**: Open directories in terminal or file manager 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() {
  local output=$(rustag "$@")
  local last_line=$(echo "$output" | tail -n 1)

  # Check if the last line is a valid directory path
  if [[ -d "$last_line" ]]; then
    cd "$last_line"
  else
    echo "$output"
  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 `bookmarks` file that maintains the bookmark information.

## Usage

### Adding a Bookmark

To bookmark the current directory, run Rustag without arguments and select "Add bookmark":

```bash
rtg
```

Follow the prompts to:
1. Select "Add bookmark" from the menu
2. Enter a custom alias for the current directory

### Viewing and Managing Bookmarks

To view and manage your bookmarks:

1. Run `rtg` without any arguments
2. Select "View bookmarks" from the menu
3. Browse your bookmarks with fuzzy search (each entry shows alias and full path)
4. Select a bookmark to perform actions:
   - **Open in Terminal**: Navigate to the directory (cd)
   - **Open in File Manager**: Open the directory in your system's file manager
   - **Edit alias**: Change the alias of the bookmark
   - **Remove bookmark**: Delete the bookmark

### Example Workflow

```bash
# Navigate to a project directory
cd ~/projects/myproject

# Add a bookmark
rtg
# Select: Add bookmark
# Enter alias: myproj

# Later, from anywhere
rtg
# Select: View bookmarks
# You'll see fuzzy searchable list:
#   myproj -> /home/user/projects/myproject
#   docs -> /home/user/documents
#   ...
# Select: myproj -> /home/user/projects/myproject
# Select: Open in Terminal
# Now you're in ~/projects/myproject
```

## Data Structure

Rustag uses two custom data structures:

- **`Bookmark`**: Represents a bookmarked directory, including:
  - `alias`: User-defined alias for the directory
  - `folder_path`: Absolute path to the directory
  - `created_at`: Timestamp when the bookmark was created
  - `last_accessed`: Timestamp when the bookmark was last accessed (optional)

- **`BookmarkList`**: Manages the collection of bookmarks using:
  - `bookmarks`: HashMap mapping aliases to Bookmark instances for O(1) lookup
  - `aliases`: Sorted vector of aliases for display purposes

## Contributing

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

## License

This project is licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))
- MIT License ([LICENSE-MIT](LICENSE-MIT))

at your option.