Skip to content

Commands

Christian Blank edited this page Nov 8, 2024 · 1 revision

Usage & Commands

Getting Started

To start using Addarr, send /start to your bot on Telegram. Only authorized users (configured in config.ini) can use the bot.

Basic Commands

General Commands

  • /start - Initialize the bot
  • /help - Show available commands
  • /ping - Check if the bot is running

TV Show Commands (Sonarr)

  • /tv <show name> - Search for a TV show
  • /upcoming - List upcoming episodes
  • /myshows - List your monitored shows

Movie Commands (Radarr)

  • /movie <movie name> - Search for a movie
  • /mymovies - List your monitored movies
  • /upcoming_movies - List upcoming movie releases

Advanced Usage

TV Show Management

When searching for a TV show using /tv, you'll get:

  • Show information
  • Available seasons
  • Quality options
  • Buttons to:
    • Add all seasons
    • Add specific seasons
    • Cancel the operation

Movie Management

When searching for a movie using /movie, you'll get:

  • Movie information
  • Release date
  • Quality options
  • Buttons to:
    • Add movie
    • Cancel operation

Response Examples

TV Show Search

When you search for a TV show:

🔍 Breaking Bad (2008)
Rating: 9.5/10
Status: Ended
Network: AMC

[Add All Seasons] [Select Seasons] [Cancel]

Movie Search

When you search for a movie:

🎬 Inception (2010)
Rating: 8.8/10
Director: Christopher Nolan
Runtime: 2h 28min

[Add Movie] [Cancel]

Tips & Tricks

  1. Use specific search terms for better results

    • Include year for more accurate results
    • Use official titles when possible
  2. Quality Profile Selection

    • Default profile is used if none specified
    • Can be changed in config.ini
  3. Monitoring Options

    • Shows are automatically monitored when added
    • Use /myshows and /mymovies to check status
  4. Search Behavior

    • Bot searches both TMDB and TVDB databases
    • Results are sorted by relevance
    • Limited to top 5 matches to avoid clutter

Error Messages

Common error responses you might see:

❌ No results found
Please try a different search term
⚠️ Already exists
This title is already in your library
🔒 Unauthorized
You don't have permission to use this command

Command Limitations

  1. Rate Limiting

    • Maximum 5 searches per minute
    • Cooldown period between searches
  2. Permission Levels

    • Some commands require admin rights
    • User management is admin-only
  3. Search Restrictions

    • Single title search only
    • No batch adding
    • No advanced query syntax

Best Practices

  1. Regular Usage

    • Check /upcoming regularly
    • Monitor /myshows and /mymovies
    • Use specific search terms
  2. Library Management

    • Verify additions with confirmation messages
    • Check quality profiles before adding
    • Use cancel button if unsure
  3. Troubleshooting

    • Use /ping to check bot status
    • Check Troubleshooting for issues
    • Report bugs through GitHub

Need Help?

If you encounter any issues:

  1. Check the Troubleshooting guide
  2. Visit the FAQ section
  3. Report issues on GitHub
  4. Use /help command for quick reference

Clone this wiki locally