OS Manuals

/usr/bin/zkg

zkg, the Zeek package manager

From zeek-zkg 9.0.1-r1 (enterprise-packages), captured 2026-11-08 by running zkg --help (exit 0). permalink

usage: zkg [-h] [--version] [--configfile FILE | --user] [--verbose] [--extra-source NAME=URL]
           {test,install,bundle,unbundle,remove,uninstall,purge,refresh,upgrade,load,unload,pin,unpin,list,search,info,config,autoconfig,env,create,template} ...

A command-line package manager for Zeek.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  --configfile FILE     Path to Zeek Package Manager config file. Precludes --user.
  --user                Store all state in user's home directory. Precludes --configfile.
  --verbose, -v         Increase program output for debugging. Use multiple times for more output
                        (e.g. -vv).
  --extra-source NAME=URL
                        Add an extra source.

commands:
  {test,install,bundle,unbundle,remove,uninstall,purge,refresh,upgrade,load,unload,pin,unpin,list,search,info,config,autoconfig,env,create,template}
                        See `zkg <command> -h` for per-command usage info.
    test                Runs unit tests for Zeek packages.
    install             Installs Zeek packages.
    bundle              Creates a bundle file containing a collection of Zeek packages.
    unbundle            Unpacks Zeek packages from a bundle file and installs them.
    remove (uninstall)  Uninstall a package.
    purge               Uninstall all packages.
    refresh             Retrieve updated package metadata.
    upgrade             Upgrade installed packages to latest versions.
    load                Register packages to be be auto-loaded by Zeek.
    unload              Unregister packages to be be auto-loaded by Zeek.
    pin                 Prevent packages from being automatically upgraded.
    unpin               Allows packages to be automatically upgraded.
    list                Lists packages.
    search              Search packages for matching names.
    info                Display package information.
    config              Show Zeek Package Manager configuration info.
    autoconfig          Generate a Zeek Package Manager configuration file.
    env                 Show the value of environment variables that need to be set for Zeek to be
                        able to use installed packages.
    create              Create a new Zeek package.
    template            Manage package templates.

Environment Variables:

    ``ZKG_CONFIG_FILE``:	Same as ``--configfile`` option, but has less precedence.
    ``ZKG_DEFAULT_SOURCE``:	The default package source to use (normally https://github.com/zeek/packages).
    ``ZKG_DEFAULT_TEMPLATE``:	The default package template to use (normally https://github.com/zeek/package-template).
Options (6)
OptionDescriptionSource
-h, --helpshow this help message and exithelp
--versionshow program's version number and exithelp
--configfile FILEPath to Zeek Package Manager config file.help
--userStore all state in user's home directory.help
--verbose, -vIncrease program output for debugging.help
--extra-source NAME=URLAdd an extra source.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.