Skip to content

fm ssh

Reference for the fm ssh command group (auto-generated from fm ssh --help).

fm ssh

text
Open an interactive terminal (or run a command) on a compute instance over
the platform session plane — no public IP, open port, or SSH daemon
required. The instance must have been created with --instance-access, and
the tenant needs the 'instance-access' entitlement.

With no command, you get an interactive login shell (a PTY is allocated
when stdin is a terminal). With a command after '--', it runs
non-interactively over pipes — script-safe: stdout is not CR/LF-mangled
and the remote exit code becomes fm's exit code. Use --tty to force a PTY
either way.

Sessions are time-limited by the platform: they end after 10 minutes of
inactivity or 1 hour total.

Usage:
  fm ssh <instance-id> [-- command] [flags]

Aliases:
  ssh, session

Examples:
  # Interactive shell
  fm ssh 9b6b2d0e-...

  # As a specific user
  fm ssh 9b6b2d0e-... --user debian

  # Run a command, keep its exit code
  fm ssh 9b6b2d0e-... -- systemctl is-active nginx

Flags:
  -h, --help          help for ssh
      --tty           force PTY allocation even when running a command or with non-TTY stdin
      --user string   target login user on the instance (default: the agent's configured user)

Global Flags:
      --config string   config file (default is $HOME/.fm/config.yaml)
  -d, --debug           enable debug/verbose output
      --no-color        disable colored output
  -o, --output string   output format: table, json, yaml, wide (default "table")
  -q, --quiet           suppress non-essential output
      --tenant string   tenant ID to operate on (overrides the active/default tenant; also FM_TENANT)