Skip to content

PLATFORMCTL

NAME

platformctl provides useful commands to interact with the platform

SYNOPSIS

platformctl [COMMAND]

DESCRIPTION

The platformctl command allow you to interact with platform the platform.

The platformctl command if fully documented inline and provides rich auto-completion facilities. This page contains only the very basic usage.

EXAMPLES

#Get global platform health 
platformctl health

#Get the help menu:
platformctl --help

LIBRARIES

platformctl uses the library located :

  • $PUNCHPLATFORM_INSTALL_DIR/lib/punch-command-app-*with-dependencies.jar

LOGGERS

The logging verbosity of platformctl is controlled by the following two files:

  • $PUNCHPLATFORM_LOG4J_CONF_DIR/log4j2-platform.xml
  • $PUNCHPLATFORM_LOG4J_CONF_DIR/log4j2.properties

In the context of shiva execution, i.e. if punchlinectl is launched through shiva on some shiva worker server, the PUNCHPLATFORM_LOG4J_CONF_DIR points on a different log4j directory

Note that these loggers use the stdout appender. This is on purpose because punchlinectl is designed to run with a stdout/stderr strategy. Its logs are either prompted to the user terminal, or are handled automatically by shiva, again through the stdout/stderr unix pipes.

SEE ALSO

environment