Command-line interface

The command-line is the Linux default user interface. It is used to maintain the operating system. Therefore also cherryEPG is using this way of performing jobs.

Login as cherryepg user before running any cherryEPG related maintenance tasks!

The command-line tool for maintenance is cherryTool. By various parameters and switches you can define the behavior of the tool. You can always run cherryTool -hto get a short command-line switch overview.

cherryTool - ver. 2.1.3 Copyright 2022 Bojan Ramšak
     cherryTool [options] -[gdiprwx zero or multiple channel_id]

     -v         use verbose output mode

     -h         show this help
     -V         show version and configuration info
     -R         systemcheck and report
     -N         systemcheck and notify to log
     -Q         show detailed database statistics
     -M chunk   inspect chunk and generate mosaic.png
     -Z message send ERROR record to log for testing
     -j package apply maintenance package to system
     -J script  convert script to maintenance package

     -L scheme  initialize EPG database and load scheme
     -l scheme  load scheme to existing database (do not remove existing services and events)
                every imported scheme is copied to archive
     -n         show last(newest) scheme in archive
     -F         list scheme in archive
     -e file    export scheme to file
     -H host    set host as target when converting xls to scheme (used to select sheet)
     -c xls     convert xls scheme file to yaml scheme

     -C         list content of carousel
     -u file    add/upload .gz file to carousel
     -p chunk   play TS chunk
     -s chunk   stop TS chunk
     -S         stop - ALL
     -y chunk   delete TS chunk from carousel TODO
     -Y         delete ALL from carousel directory - stop carousel

     -G target  grab&ingest by target: all, daily, hourly, weekly
     -B         build all output EIT chunks

     -f         reset section and version table (force next build)
     -A         delete ALL from stock directory
     -P         reset rule table
     -O         cleanup database - delete old events and log entries
     -T         reset all tables in database to empty state (drop+init)

     Do operations on service using {channel_id} as id. When no id-s given, go for all!
     -g id      grab service schedule data
     -d id      delete ingest files for service
     -i id      parse/ingest files for service
     -I id      parse/ingest files for service and dump event data (debugging of parser)
     -r id      reset ingest state (delete *.md5.parsed)
     -w id      wipe/remove service definition and data
     -x id      export events for service in XMLTV format to file {service_id.xml}

     -W         run the web server

    "cherryTool" is a command-line interface for cherryEpg.

    cherryEpg will look for a configuration file before reading its command
    line parameters. The default location is "$USER_HOME/config.yml".