Honeycomb Commands Reference¶
Honeycomb¶
Honeycomb is a honeypot framework.
Honeycomb [OPTIONS] COMMAND [ARGS]...
Options
-
-H,--home<home>¶ Honeycomb home path [default: /home/docs/.config/honeycomb]
-
--iamroot¶ Force run as root (NOT RECOMMENDED!)
-
-c,--config<config>¶ Path to a honeycomb.yml file that provides instructions
-
-v,--verbose¶ Enable verbose logging
-
--version¶ Show the version and exit.
Environment variables
-
DEBUG - Provide a default for
--verbose
integration¶
Honeycomb integration commands.
Honeycomb integration [OPTIONS] COMMAND [ARGS]...
configure¶
Configure an integration with default parameters.
You can still provide one-off integration arguments to honeycomb.commands.service.run() if required.
Honeycomb integration configure [OPTIONS] INTEGRATION [ARGS]...
Options
-
-e,--editable¶ Load integration directly from unspecified path without installing (mainly for dev)
-
-a,--show_args¶ Show available integration arguments
Arguments
-
INTEGRATION¶ Required argument
-
ARGS¶ Optional argument(s)
install¶
Install a honeycomb integration from the online library, local path or zipfile.
Honeycomb integration install [OPTIONS] [INTEGRATIONS]...
Arguments
-
INTEGRATIONS¶ Optional argument(s)
list¶
List integrations.
Honeycomb integration list [OPTIONS]
Options
-
-r,--remote¶ Include available integrations from online repository
show¶
Show detailed information about a package.
Honeycomb integration show [OPTIONS] INTEGRATION
Options
-
-r,--remote¶ Show information only from remote repository
Arguments
-
INTEGRATION¶ Required argument
service¶
Honeycomb service commands.
Honeycomb service [OPTIONS] COMMAND [ARGS]...
install¶
Install a honeypot service from the online library, local path or zipfile.
Honeycomb service install [OPTIONS] [SERVICES]...
Arguments
-
SERVICES¶ Optional argument(s)
list¶
List services.
Honeycomb service list [OPTIONS]
Options
-
-r,--remote¶ Include available services from online repository
logs¶
Show logs of daemonized service.
Honeycomb service logs [OPTIONS] SERVICES...
Options
-
-n,--num<num>¶ Number of lines to read from end of file [default: 10]
-
-f,--follow¶ Follow log output
Arguments
-
SERVICES¶ Required argument(s)
run¶
Load and run a specific service.
Honeycomb service run [OPTIONS] SERVICE [ARGS]...
Options
-
-d,--daemon¶ Run service in daemon mode
-
-e,--editable¶ Load service directly from specified path without installing (mainly for dev)
-
-a,--show-args¶ Show available service arguments
-
-i,--integration<integration>¶ Enable an integration
Arguments
-
SERVICE¶ Required argument
-
ARGS¶ Optional argument(s)
show¶
Show detailed information about a package.
Honeycomb service show [OPTIONS] SERVICE
Options
-
-r,--remote¶ Show information only from remote repository
Arguments
-
SERVICE¶ Required argument
status¶
Show status of installed service(s).
Honeycomb service status [OPTIONS] [SERVICES]...
Options
-
-a,--show-all¶ Show status for all services
Arguments
-
SERVICES¶ Optional argument(s)
stop¶
Stop a running service daemon.
Honeycomb service stop [OPTIONS] SERVICE
Options
-
-e,--editable¶ Load service directly from specified path without installing (mainly for dev)
Arguments
-
SERVICE¶ Required argument
test¶
Execute the service’s internal test method to verify it’s working as intended.
If there’s no such method, honeycomb will attempt to connect to the port listed in config.json
Honeycomb service test [OPTIONS] [SERVICES]...
Options
-
-f,--force¶ Do not check if service is running before testing
-
-e,--editable¶ Run service directly from specified path (main for dev)
Arguments
-
SERVICES¶ Optional argument(s)