Skip to content

server command group

The server command group exposes read-only metadata about the running {{ product_name }} server. Use it to confirm which build a host profile is talking to and to run a quick health check immediately after logging in.

The alpine-admin-cli is a remote gRPC client. Every command in this group queries a live server, so you must first create a host profile and authenticate:

  1. Create a host profile with profile hosts create.
  2. Authenticate with profile authn login.
  3. Run server info to verify connectivity and inspect the server build.

First post-login health check

Run bin/admin.sh server info right after profile authn login. A successful response confirms the host profile, network path, and authenticated session are all working before you attempt any state-changing command.

Commands in this group

Command Purpose Reference
server info Display the running server's version, git commit, build time, and public key server info

Group help

bin/admin.sh server --help

server info

Display the running server's metadata: version, git commit, build time, and public key. The values are returned by the server's GetServerInfo RPC, making server info the server-side counterpart to the client's own -V/--version. It is a read-only call that changes no state and is safe to run at any time.

Syntax

bin/admin.sh server info [options]

Required options

This command has no command-specific required options.

Optional options

Show optional options
Option Default Description
-f, --out-format YAML Output format: JSON or YAML

Validation rules

  • -f/--out-format accepts only JSON or YAML (case-insensitive); any other value is rejected as invalid input.
  • server info reaches a live server, so a host profile and an authenticated session are prerequisites. Create the profile with profile hosts create and authenticate with profile authn login.

Example

bin/admin.sh server info -f json

Select a non-default host profile for a single invocation with the global -p/--profile option, placed before the command path:

bin/admin.sh -p prod-admin server info -f yaml

Standard CLI options are documented in Global options.

FAQ

Do I need to log in before running server info?

Yes. The alpine-admin-cli is a remote gRPC client, so server info reaches a live server. Create a host profile with profile hosts create and authenticate with profile authn login first.

What metadata does server info return?

It returns the running server's version, git commit, build time, and public key.

Which output formats does server info support?

Use -f/--out-format with either JSON or YAML. The default is YAML.

Does server info change any server state?

No. It is a read-only query, which makes it a safe first health check after login.