ts status

Show whether the targeted server answers and reports itself healthy, and the addresses of its Portal, API, and Hub.

Usage

ts status
ts status --server=<url|host>
ts status --local

Description

The first command to run against a server you are not sure about. It asks the server for its health, which needs no sign-in, and reports whether the server answers at all and what it considers its own health. The health answer carries no version, so ts status does not report the server's version; ts version reports the version of ts itself.

The Portal, API, and Hub addresses are not reported by the server: each is a fixed path under the address you dialed, so they show where ts and other clients reach those services through that address.

--local reads the install on this machine directly over loopback, which answers a different question: not "can I reach it" but "is it running here."

Examples

# The stored default server
ts status

# Somewhere else, without changing the default
ts status --server=https://turbo.example.net

# The install on this box
ts status --local

# Health as a field, for a monitoring script
ts status --format=json

Output

Server:  https://turbo.example.net
Health:  Healthy
Portal:  https://turbo.example.net
API:     https://turbo.example.net
Hub:     https://turbo.example.net/hub

Exit Codes

0 when the server answers and reports itself healthy. -1 when no server is configured and none is named, or --local finds no install on this machine. -3 when the server cannot be reached, or when it answers but reports itself unhealthy — in both cases something is wrong with the server rather than with your request.

Related Commands

• ts config — Set the default server this uses.
• ts version — The version of ts itself.