Pathmaster Documentation

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

Note

This project is being migrated from Rust to Go. See the Go Version section for details. The current Rust implementation remains fully functional.

Getting Started

• Installation Guide
  • System Requirements
  • Installation Methods
  • Verifying Installation
  • Shell Integration
  • Troubleshooting Installation
• Quick Start Guide
  • Basic Operations
  • Path Validation
  • Backup Management
  • Common Workflows
  • Next Steps
• Basic Usage Guide
  • Overview
  • Managing PATH Entries
  • Path Validation
  • Backup Management
  • Best Practices
  • Next Steps

Commands

• Command Overview
  • Directory Management Commands
  • Validation Commands
  • Backup Commands
  • Global Options
  • Command Return Values
  • Command Combinations
• PATH Management Commands
  • Directory Addition
  • Directory Removal
  • PATH Listing
  • Best Practices
• Validation Commands
  • Path Checking
  • Path Cleanup
  • Common Use Cases
  • Best Practices
• Backup Commands
  • Backup Mode Selection
  • Backup History
  • Restore Operations
  • Best Practices

Features

• Features Overview
  • Core Features
  • Safety Features
  • Performance Features
  • User Experience
  • Future Features
• Backup System
  • Backup Modes
  • Mode Selection
  • Backup Storage
  • Backup Management
  • Best Practices
• Shell Support
  • Supported Shells
  • Configuration Management
  • Shell-Specific Features
  • Framework Support
  • Best Practices
• Validation
  • Path Validation
  • Validation Commands
  • Validation Types
  • Error Handling
  • Best Practices

User Guides

• Error Handling
  • Common Error Types
  • How Pathmaster Handles Errors
  • Debugging Techniques
  • Error Exit Codes
  • Best Practices
• Troubleshooting
  • Common Issues and Solutions
  • Diagnostic Commands
  • When All Else Fails
• System Integration
  • Integrating with Shell Startup
  • Script Integration
  • System Maintenance Integration
  • Package Manager Integration
  • Directory Service Integration
  • Containerization
  • Best Practices
• Migration Guide
  • Migrating from Manual PATH Management
  • Migrating from Other PATH Management Tools
  • Version Migration Notes
  • Handling Breaking Changes
  • Best Practices for Future Migrations

Reference

• Shell Configuration
  • Supported Shells
  • How Shell Detection Works
  • Modification Approach
  • Shell-Specific Implementations
  • Best Practices
  • Troubleshooting
• Backup Formats
  • Backup Storage Location
  • PATH Backup Format
  • Shell Configuration Backups
  • Backup Modes
  • Listing Backups
  • Restoring from Backups
• Configuration Options
  • Command-Line Options
  • Command-Specific Options
  • Environment Variables
  • Configuration Files
  • Planned Future Options
  • Best Practices
  • Default Behaviors

Go Version

• Go Migration Overview
  • Migration Goals
  • Timeline
  • Current Status
  • Development Repositories
  • Contributing to the Go Version
• Go Usage Differences
  • Command Line Interface
  • New Features in Go Version
  • Behavior Differences
  • Compatibility
  • Feedback on Differences
• Go Feature Parity Status
  • Core Functionality
  • Shell Support
  • v0.3.0 Features
  • v0.4.0 Features
  • Legend
  • Current Development Focus
  • Estimated Timeline

Project Information

• Pathmaster Roadmap