fm auth
Reference for the fm auth command group (auto-generated from fm auth --help).
fm auth
text
Manage authentication to the Frostmoln Cloud Platform.
Use these commands to log in, log out, and check your authentication status.
Examples:
fm auth login
fm auth logout
fm auth status
Usage:
fm auth [command]
Available Commands:
api-key Manage API keys
login Log in to Frostmoln Cloud
logout Log out from Frostmoln Cloud
status Show authentication status
token Manage authentication tokens
Flags:
-h, --help help for auth
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)
Use "fm auth [command] --help" for more information about a command.fm auth api-key
text
Manage API keys for authentication.
Usage:
fm auth api-key [command]
Aliases:
api-key, apikey
Available Commands:
clear Clear the stored API key
set Set an API key for authentication
Flags:
-h, --help help for api-key
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)
Use "fm auth api-key [command] --help" for more information about a command.fm auth api-key clear
text
Clear the stored API key from your configuration.
Usage:
fm auth api-key clear [flags]
Flags:
-h, --help help for clear
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)fm auth api-key set
text
Set an API key for authentication.
This will store the API key in your configuration file.
API keys can be created in the Frostmoln console under Settings > API Keys.
Usage:
fm auth api-key set <api-key> [flags]
Flags:
-h, --help help for set
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)fm auth login
text
Log in to the Frostmoln Cloud Platform.
Opens your browser to authenticate against the Frostmoln identity provider
using the OAuth 2.0 device-authorization flow (no password is entered in the
terminal). Your tokens are stored in ~/.fm/config.yaml.
For automation (CI, scripts, Terraform), use an API key instead:
fm auth api-key set <key> # or set FROSTMOLN_API_KEY
Examples:
# Interactive login (opens a browser)
fm auth login
# Headless / SSH session — print the URL + code, don't open a browser
fm auth login --no-browser
Usage:
fm auth login [flags]
Flags:
-h, --help help for login
--no-browser Don't open a browser; print the URL and code to enter manually
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)fm auth logout
text
Log out from the Frostmoln Cloud Platform.
This will clear your stored credentials and invalidate your session.
Usage:
fm auth logout [flags]
Flags:
-h, --help help for logout
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)fm auth status
text
Show the current authentication status and user information.
Usage:
fm auth status [flags]
Aliases:
status, whoami
Flags:
-h, --help help for status
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)fm auth token
text
Manage authentication tokens including refresh and display.
Usage:
fm auth token [command]
Available Commands:
refresh Refresh the access token
show Show the current access token
Flags:
-h, --help help for token
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)
Use "fm auth token [command] --help" for more information about a command.fm auth token refresh
text
Refresh the access token using the refresh token.
Usage:
fm auth token refresh [flags]
Flags:
-h, --help help for refresh
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)fm auth token show
text
Show the current access token.
WARNING: This displays sensitive information. Use with caution.
Usage:
fm auth token show [flags]
Flags:
-h, --help help for show
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)