Environment Variables

Each app has environment variables set by Whisp to help you run your app.

These are each available as environment variables.

Variable

Description

Notes

WHISP_APP

The name of the app being requested

WHISP_CLIENT_IP

The IP address of the connecting client

WHISP_USER_PUBLIC_KEY

Validated public key of the connecting user (ssh-ed25519 4ge..)

This has been checked against their private key and can be trusted

WHISP_TTY

The TTY information for the connection

e.g. /dev/ttys072

WHISP_USERNAME

The username used in the SSH connection

Unavailable when no username passed, or when the username is a valid app

WHISP_COLS

Requested terminal width in chars

WHISP_ROWS

Requested terminal height

WHISP_WIDTH_PX

Requested terminal width in pixels

WHISP_HEIGHT_PX

Requested terminal height in pixels

WHISP_PARAM_{name}

Passed only when using app params, i.e. chat-{roomName}