Skip to content

cerberussg/auxbox

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

auxbox

A lightweight CLI music player for background listening with daemon architecture. Perfect for casual listening and DJ track preparation.

# One command from silence to sound
auxbox play -f ~/Music

# Hot-swap sources while playing
auxbox play -f ~/different-folder/

# Shuffle and repeat for infinite playback
auxbox play -f ~/Music/study-mix/ -s -r

✨ Features

  • Instant playback - One command starts your music
  • Hot-swapping - Switch sources seamlessly while playing
  • Shuffle & repeat - Random playback with multiple repeat modes
  • DJ workflow - Rate and tag tracks for rekordbox integration
  • Daemon architecture - Background operation, persistent playback
  • Format support - MP3, WAV, AIFF/AIF

🚀 Quick Start

Install

git clone https://github.com/cerberussg/auxbox
cd auxbox
go build -o auxbox cmd/auxbox/*.go
mv auxbox ~/.local/bin/  # Or any directory in your PATH

See INSTALLATION.md for platform-specific instructions.

Basic Usage

# Load and play instantly
auxbox play -f ~/Music/jazz/

# Navigate tracks
auxbox skip      # Next track
auxbox back      # Previous track

# Controls
auxbox pause     # Pause playback
auxbox play      # Resume
auxbox shuffle   # Toggle shuffle
auxbox repeat    # Cycle repeat modes
auxbox volume 75 # Set volume

# Information
auxbox status    # Current track info
auxbox list      # Show all tracks

# Done listening
auxbox exit

📚 Documentation

🎵 DJ Features

auxbox is perfect for DJs who want to organize tracks without opening heavy DJ software:

# Rate tracks while listening (Phase 4 - Coming Soon)
auxbox stars 5

# Tag genres and labels (Phase 5 & 6 - Planned)
auxbox genre "Deep House"
auxbox label "Defected Records"

All metadata syncs with rekordbox using industry-standard ID3v2 tags. See DJ_WORKFLOW.md for details.

🛠️ Development Status

Phase Feature Status
Phase 1 Streamlined UX ✅ Complete
Phase 2 Shuffle Mode ✅ Complete
Phase 3 Repeat Modes ✅ Complete
Phase 4 Star Rating 🚧 In Progress
Phase 5 Genre Tagging 📋 Planned
Phase 6 Label Tracking 📋 Planned

See ROADMAP.md for the complete development plan.

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.

📝 License

[Add your license information here]

🔗 Links

About

A music player for the command line

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages