Getting Started with Phonox

Getting Started with Phonox

Welcome to Phonox! This guide will help you get up and running in minutes.

1. Clone the Repository

git clone https://github.com/Hoshi42/phonox.git
cd phonox

2. Add Your Anthropic API Key

Phonox uses Anthropic’s Claude for AI-powered analysis. You’ll need an API key.

cp .env.example .env
./phonox-cli configure --anthropic YOUR_ANTHROPIC_KEY

Get your key at console.anthropic.com.

For more details, see the API Key Setup Guide.

3. Start Everything

Prerequisites: Install Docker

Phonox runs in Docker containers. Please install Docker before continuing:

After installing Docker, restart your computer if prompted.

Start Phonox with phonox-cli

  1. Make scripts executable (only needed once):

    chmod +x phonox-cli start-cli.sh

  2. Launch the Phonox CLI:

    ./phonox-cli

    This opens an interactive menu. Use the arrow keys and Enter to select options.

  3. Build and start everything:

    • Select Install + start from the menu (recommended for first run)
    • Or run directly: 
      ./phonox-cli install --up

  4. Open the dashboard:

If you need to stop or restart Phonox:

./phonox-cli stop      # Stop all containers
./phonox-cli restart   # Restart everything

For more details, see the Phonox CLI Guide.

4. Add Your First Record

Ready to catalog your collection? See the Step-by-Step Video Guide for a walkthrough.

5. Backup and Restore

Keep your collection safe! Learn how to backup and restore your data in the Backup & Restore Guide.

More Resources

You’re ready to start cataloging your vinyl collection with Phonox!

← Back to all posts