For the complete documentation index, see llms.txt. This page is also available as Markdown.

Health

Check the health and connectivity of the remote SFP server

sfp server health

Check the health and connectivity of the remote SFP server

USAGE
  $ sfp server health [--json] [-d] [--check-auth] [--repository <value>] [-e <value>] [-t <value>]
    [--sfp-server-url <value>] [-g <value>...] [--loglevel
    trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

FLAGS
  -d, --detailed                    Show detailed health status including all components
  -e, --email=<value>               Email address for authenticated user. Ignored if --application-token is provided.
                                    Can be set via SFP_SERVER_USER env var.
  -g, --logsgroupsymbol=<value>...  Symbol used by CICD platform to group/collapse logs in the console. Provide an
                                    opening group, and an optional closing group symbol.
  -t, --application-token=<value>   Application token for CI/CD authentication. Can be set via SFP_SERVER_TOKEN env var
                                    (CLI flags take precedence over env vars).
      --check-auth                  Validate authentication token with the server
      --loglevel=<option>           [default: info] logging level for this command invocation
                                    <options: trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL>
      --repository=<value>          The repository identifier. E.g `owner/repo` for GitHub/GitLab or `org/project/repo`
                                    for Azure DevOps
      --sfp-server-url=<value>      URL of the SFP server. Can be set via SFP_SERVER_URL env var or config: sfp
                                    config:set server-url

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Check the health and connectivity of the remote SFP server

EXAMPLES
  $ sfp server health

  $ sfp server health --detailed

  $ sfp server health --check-auth

  $ sfp server health --check-auth --detailed

  $ sfp server health --json

See code: src/commands/server/health.ts

Last updated

Was this helpful?