zkg.rst

zkg Command-Line Tool

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :nosubcommands:

    --configfile : @after
        See :ref:`zkg-config-file`.

Commands

test

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: test

install

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: install

remove

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: remove

Note

You may also say uninstall.

purge

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: purge

bundle

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: bundle

unbundle

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: unbundle

refresh

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: refresh

upgrade

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: upgrade

load

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: load

unload

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: unload

pin

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: pin

unpin

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: unpin

list

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: list

search

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: search

info

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: info

config

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: config

autoconfig

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: autoconfig

env

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: env

create

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: create

template info

.. argparse::
    :module: zkg
    :func: argparser
    :prog: zkg
    :path: template info

Config File

The :program:`zkg` command-line tool uses an INI-format config file to allow users to customize their :doc:`Package Sources <source>`, :doc:`Package <package>` installation paths, Zeek executable/source paths, and other :program:`zkg` options.

See the default/example config file below for explanations of the available options and how to customize them:

.. literalinclude:: ../zkg.config