# koha-list
koha

# koha-list --all
unrecognized option

# koha-enable
Enables Koha instances.

Usage: /usr/sbin/koha-enable instancename1 instancename2...

Missing instance name...
# koha-disable
Disables Koha instances.

Usage: /usr/sbin/koha-disable instancename1 instancename2...

Missing instance name...

# koha-create
Creates new Koha instances.

Usage:

  /usr/sbin/koha-create [DB usage mode] [options] instancename

DB usage mode:
  --create-db               Create a new database on localhost. (default).
  --request-db              Creates a instancename-db-request.txt file where
                            you adjust your DB settings and re-run with --populate-db.
  --populate-db             Finish the installation you started with --request-db after
                            you adjusted the instancename-db-request.txt file.

# koha-remove
Please specify a Koha instance name. Your choices are:
koha

# koha-shell --help
koha-shell -- gives you a shell with your Koha environment set up

Usage: koha-shell [options] [instance name]

Options:
    -c, --command COMMAND   pass COMMAND to the invoked shell
    -h, --help              show this help and quit
    -l, --login             make the shell a login shell
    -m, -p,
    --preserve-environment  do not reset environment variables
    -s, --shell SHELL       use SHELL instead of the one from your environment
    -v, --verbose           output the full command that will be executed

# koha-shell koha -c whoami
koha-koha
# koha-shell koha -c "perl -MC4::Context -e 'print C4::Context->preference(q{SearchEngine}), qq{\n}'"
Elasticsearch

# echo "select version(),count(*) from borrowers;" | koha-mysql koha
version()               count(*)
11.4.13-MariaDB-ubu2404 1

# koha-foreach "echo hi from %INSTANCE%"
hi from %INSTANCE%
# koha-foreach --help
/bin/sh: 0: Illegal option --
koha: 2 status returned by "--help"

# koha-reset-passwd
Resets the password for the specified user on the Koha instance.

Usage: /usr/sbin/koha-reset-passwd instancename userid

Note: The generated password will be printed.
Wrong parameters

Usage:
koha-worker [--start|--stop|--restart] [--queue queue_name|--all-queues] [--quiet|-q] instancename1 [instancename2...]
koha-worker --status instancename1 [instancename2...]
koha-worker -h|--help

    --queue               Specify the queue/worker to perform the action on - 'default' is
                          used if not specified (unless --all-queues is passed)
                          current queues are: default, long_tasks

# koha-plack --status koha
Plack not running for koha: failed!
# koha-worker --status koha
worker not running for koha (default): failed!
# koha-indexer --status koha
Indexer not running for koha: failed!
# koha-zebra --status koha
Zebra not running for koha: failed!

# koha-elasticsearch
Manage Elasticsearch-related tasks for Koha instances

Usage: /usr/sbin/koha-elasticsearch [actions] [options] instancename1 instancename2...

Actions:
    --rebuild         Trigger a rebuild process

Options:
    --delete|-d       Delete elasticsearch index before reindexing.
    --reset|-r        Reset elasticsearch mappings from file.
    --authorities|-a  Only run process for authorities.
    --biblios|-b      Only run process for biblios.

# koha-elasticsearch --rebuild -v koha
[963] Checking state of biblios index
[963] Checking state of authorities index
[963] Indexing biblios
[963] Committing final records...
Use of uninitialized value in string eq at /usr/share/koha/bin/search_tools/rebuild_elasticsearch.pl line 368.
[963] Total 0 records indexed
[963] Indexing authorities
[963] Committing final records...
Use of uninitialized value in string eq at /usr/share/koha/bin/search_tools/rebuild_elasticsearch.pl line 368.
[963] Total 0 records indexed

# curl -s 'http://es:9200/_cat/indices?v'
health status index                 uuid                   pri rep docs.count docs.deleted store.size pri.store.size dataset.size
yellow open   koha_koha_authorities EZmegIlbS_ilbg_623Cvwg   5   1          0            0      1.2kb          1.2kb        1.2kb
yellow open   koha_koha_biblios     MuTtX0kMRv2dl0PxLqDPbg   5   1          0            0      1.2kb          1.2kb        1.2kb

# koha-rebuild-zebra
Rebuild the Zebra indexes for Koha instances. The default behaviour
is to do an incremental rebuild.

Usage: /usr/sbin/koha-rebuild-zebra [options] instancename1 instancename2...
Options:
    --authorities|-a  Only run process for authorities.
    --biblios|-b      Only run process for biblios.
    --full|-f         Does a reindex of the whole collection.
    --force           Run incremental indexing even if USE_INDEXER_DAEMON="yes"
    --quiet|-q        Sometimes be a bit quieter for scripts/cronjobs.
    --verbose|-v      Be verbose. Can be multiple.
    --help|-h         Print this help.

# koha-dump --help
koha-dump

This script dumps your Koha instance data for backup or migration.

Usage:
koha-dump [--quiet|-q] [--exclude-indexes] instancename1 [instancename2...]

    --schema-only         Dump only the database schema
    --exclude-indexes     Exclude Zebra indexes from the backup
    --exclude-logs        Exclude /var/log/koha/name from the backup
    --uploaded_files      Include uploaded files.
    --uploaded_temp_files Include temporary uploaded files.
    --without-db-name     Do not include database name

# koha-dump koha
Dumping Koha site koha:
* DB to /var/spool/koha/koha/koha-2026-11-01.sql.gz
* configs, logs to /var/spool/koha/koha/koha-2026-11-01.tar.gz
Done.

# ls -l /var/spool/koha/koha/
total 324
-rw-r----- 1 root koha-koha 289452 Nov  1 15:58 koha-2026-11-01.sql.gz
-rw-r----- 1 root koha-koha  30525 Nov  1 15:58 koha-2026-11-01.tar.gz

# koha-restore
Usage: /usr/sbin/koha-restore sqldump configdump

# koha-run-backups --help
/usr/sbin/koha-run-backups - performs backups of the koha installations on the system

Options:
    --output /path     The directory that the resulting files will be placed into.
                       (default: /var/spool/koha)
    --days 2           The number of days to keep backups around for
                       (default: 2)
    --exclude-indexes  Exclude Zebra indexes from the backups (default: false)
    --exclude-logs     Exclude /var/log/koha/name from the backup (default: false)

Note: backups produced using this tool can be restored using `koha-restore'.

# koha-upgrade-schema koha
Upgrading database schema for koha
No database change required

# koha-translate --help
koha-translate

This script lets you manage your Koha templates translations.

Usage:
koha-translate --list|-l [--available|-a]  [-d|--dev instance]
koha-translate --check|-c language_code]   [-d|--dev instance]
koha-translate --install|-i language_code] [-d|--dev instance]
koha-translate --update|-u language_code]  [-d|--dev instance]
koha-translate --remove|-r language_code]  [-d|--dev instance]

    -l | --list           List the installed or available (combined with -a)
                          language translations
    -a | --available      Used in conjunction with -l to show all languages
    -c | --check          Check that the language .PO files are present
    -i | --install        Install the specified language translations
    -u | --update         Update the specified language translations
    -r | --remove         Remove the specified language translations
    -d | --dev            Limit actions to a specific dev instance

# koha-email-enable
Enables the email for Koha instances.

Usage: /usr/sbin/koha-email-enable instancename1 instancename2...

Missing instance name...

# perl /usr/share/koha/bin/cronjobs/overdue_notices.pl --help
Can't locate Koha/Script.pm in @INC (you may need to install the Koha::Script module)
(@INC contains: /etc/perl /usr/local/lib/x86_64-linux-gnu/perl/5.36.0 ... )
at /usr/share/koha/bin/cronjobs/overdue_notices.pl line 29.
BEGIN failed--compilation aborted at /usr/share/koha/bin/cronjobs/overdue_notices.pl line 29.

# koha-shell koha -c "perl /usr/share/koha/bin/cronjobs/overdue_notices.pl -n"

Usage:
    overdue_notices.pl [ -n ][ --library <branchcode> ][ --library
    <branchcode> ... ] [ --max <number of days> ][ --csv [<filename>] ][
    --itemscontent <field list> ] [ --email <email_type> ... ]

     Options:
       --help                          Brief help message.
       --man                           Full documentation.
       --verbose | -v                  Verbose mode. Can be repeated for increased output.
       --nomail | -n                   No email will be sent.
       --max          <days>           Maximum days overdue to deal with.
       --library      <branchcode>     Only deal with overdues from this library.
                                       (repeatable : several libraries can be given)
       --csv          <filename>       Populate CSV file.
       --html         <directory>      Output html to a file in the given directory.
       --text         <directory>      Output plain text to a file in the given directory.
       --itemscontent <list of fields> Item information in templates.
       --borcat       <categorycode>   Category code that must be included.
       --borcatout    <categorycode>   Category code that must be excluded.
       --triggered | -t                Only include triggered overdues.

Usage: /usr/share/koha/bin/cronjobs/cleanup_database.pl

   -h --help          prints this help message, and exits, ignoring all
                      other options
   --confirm          Confirmation flag, the script will be running in dry-run mode is not set.
   --sessions         purge the sessions table.  If you use this while users
                      are logged into Koha, they will have to reconnect.
   --sessdays DAYS    purge only sessions older than DAYS days.
   -v --verbose       will cause the script to give you a bit more information
                      about the run.
   --zebraqueue DAYS  purge completed zebraqueue entries older than DAYS days.
                      Defaults to 30 days if no days specified.
   -m --mail DAYS     purge items from the mail queue that are older than DAYS days.
                      Defaults to 30 days if no days specified.
   --merged           purged completed entries from need_merge_authorities.
   --messages DAYS    purge entries from messages table older than DAYS days.
                      Defaults to 365 days if no days specified.
   --import DAYS      purge records from import tables older than DAYS days.
                      Defaults to 60 days if no days specified.
   --z3950            purge records from import tables that are the result
                      of Z39.50 searches
   --fees DAYS        purge entries accountlines older than DAYS days, where
                      amountoutstanding is 0 or NULL.
                      In the case of --fees, DAYS must be greater than
                      or equal to 1.