lumin 0.1.13

A library for searching and displaying local files
Documentation 
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

# lumin: A File Searcher

A Rust utility for searching, traversing, and viewing files with rich filtering options and type-aware content handling.

## Features

- **Search**: Find text patterns in files using regex
- **Traverse**: List files in directories with advanced filtering
- **View**: Display file contents with type detection (text, binary, image)

## Installation

```
cargo install --path .
```

## Usage

### Search for text patterns

```
lumin search <PATTERN> <DIRECTORY> [OPTIONS]
```

Options:

- `--case-sensitive`: Enable case-sensitive matching
- `--ignore-gitignore`: Ignore .gitignore rules
- `--omit-context <NUM>`: Limit context around matches to show only NUM characters before and after each match (the matched pattern itself is always displayed in full)
- `-B, --before-context <NUM>`: Show NUM lines before each match (similar to grep's -B option)
- `-A, --after-context <NUM>`: Show NUM lines after each match (similar to grep's -A option)
- Both -B and -A can be combined to show context on both sides of matches

### Traverse directories

```
lumin traverse <DIRECTORY> [OPTIONS]
```

Options:

- `--case-sensitive`: Enable case-sensitive filtering
- `--ignore-gitignore`: Ignore .gitignore rules
- `--all-files`: Include binary files (default: text files only)

### View file contents

```
lumin view <FILE_PATH> [OPTIONS]
```

Options:

- `--max-size <SIZE>`: Maximum file size in bytes to read
- `--line-from <NUM>`: Start viewing from this line number (1-based, inclusive)
- `--line-to <NUM>`: End viewing at this line number (1-based, inclusive)

The view command outputs file content with:

- File path
- File type
- Contents (text, binary, or image with appropriate metadata)
- For text files: total line count information

## Key Features

- Gitignore-aware operations
- Type detection using extension and content analysis
- Strongly typed output structures
- Comprehensive error handling
- Efficient line-based filtering for text files with optimized size checking
- Comprehensive context control for search results (before/after matches) to focus on relevant code

## Development

```
# Build
cargo build

# Test
cargo test

# Format code
cargo fmt

# Run linter
cargo clippy
```

## License

MIT

## Contributing

See [CONTRIBUTING.md](./tests/test_dir_1/docs/CONTRIBUTING.md) for guidelines.