pathmaster 0.3.0

pathmaster is a powerful command-line tool written in Rust for managing your system's PATH environment variable.
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

# pathmaster

A powerful command-line tool for managing your system's PATH environment variable, providing safe and efficient PATH manipulation with automatic backups and validation.

Version: 0.3.0

[![Crates.io](https://img.shields.io/crates/v/pathmaster.svg)](https://crates.io/crates/pathmaster)
[![Documentation](https://img.shields.io/badge/docs-ReadTheDocs-blue.svg)](https://pathmaster.readthedocs.io/)
[![API Docs](https://docs.rs/pathmaster/badge.svg)](https://docs.rs/pathmaster)

## Features

- Safe PATH manipulation
- Smart shell configuration management
- Comprehensive validation and error checking
- Basic error prevention

## Upcoming Features

- Enhanced backup system with multiple formats (JSON/TOML/plain text)
- User-defined backup locations
- Format conversion utilities
- Flexible backup modes for different needs
- Complete shell configuration management

See our [Roadmap](https://pathmaster.readthedocs.io/en/latest/ROADMAP.html) for more details.

## Quick Start

### Installation

```bash
cargo install pathmaster
```

### Man Page Installation

After installing with Cargo, you can install the man page with:

```bash
pathmaster-install-man $HOME/.local
```

Or build from source:

```bash
git clone https://github.com/jwliles/pathmaster.git
cd pathmaster
cargo build --release
```

### Basic Usage

```bash
# Add a directory to PATH
pathmaster add ~/bin

# List current PATH entries
pathmaster list

# Remove invalid entries
pathmaster flush

# Show backup history
pathmaster history
```

## Documentation

- **User Documentation**: [https://pathmaster.readthedocs.io/](https://pathmaster.readthedocs.io/)
- **API Documentation**: [https://docs.rs/pathmaster](https://docs.rs/pathmaster)
- **Man Page**: `man pathmaster`
- **Command Help**: `pathmaster --help`

## Contributing

Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on:

- Code of Conduct
- Development process
- Bug reports
- Feature requests
- Pull requests

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.