grafana-util-profile.1

NAME

grafana-util-profile - manage repo-local grafana-util profile configuration

SYNOPSIS

grafana-util profile [SUBCOMMAND] [OPTIONS]

DESCRIPTION

list, inspect, validate, add, and initialize repo-local grafana-util profiles.

when you want to keep Grafana connection defaults in the current checkout and reuse them with --profile.

BEFORE / AFTER

• Before: connection settings live in scattered flags or ad hoc shell history, so the same live command is hard to repeat later.
• After: a named profile keeps URL, auth, and secret handling in one place so live commands stay shorter and easier to reuse.

SUBCOMMANDS

list

list profile names from the resolved grafana-util config file. Use when: Need to confirm which profiles are available in the current checkout.

show

show the selected profile as text, table, csv, json, or yaml. Use when: Want to inspect the resolved connection settings before running a live command.

current

show the currently selected profile, resolved config path, auth mode, and secret mode. Use when: Want to confirm which repo-local profile would be used before a live command runs.

validate

validate the selected profile and optionally check Grafana reachability. Use when: Want to confirm profile selection, auth shape, and secret resolution before running a live command.

add

create or replace one named profile without hand-editing grafana-util.yaml. Use when: Want a friendlier path than editing YAML directly, especially for storing reusable auth defaults.

example

print a comment-rich reference config that operators can copy and adapt. Use when: Want one canonical example that explains the supported profile fields and secret storage modes.

init

initialize grafana-util.yaml in the current working directory. Use when: A checkout does not yet have a repo-local profile file and you want the built-in starter template.

SUCCESS CRITERIA

• one profile name captures the connection setup you actually want to reuse
• secret storage mode matches the environment instead of forcing every command to restate auth
• downstream live commands can stay readable because the profile hides repeated boilerplate

FAILURE CHECKS

- if a command fails after switching profiles, verify the resolved show output before assuming the command is broken

- if a secret is missing, check whether the profile is using file, os, or encrypted-file storage and whether that mode fits the current machine

- if a live command still needs too many flags, reconsider whether the profile should carry the default URL or auth values instead

Key flags: the root command is a namespace; operational flags live on subcommands. The shared root flag is --color.

Examples:

# Purpose: List profiles available in the current checkout.

grafana-util profile list

# Purpose: Inspect the resolved profile before running live commands.

grafana-util profile show --profile prod --output-format yaml

# Purpose: Show the currently selected profile and resolved config path.

grafana-util profile current --profile prod

# Purpose: Validate the selected profile and check Grafana reachability.

grafana-util profile validate --profile prod --live

# Purpose: Create a reusable production profile with prompt-based secrets.

grafana-util profile add prod --url https://grafana.example.com --basic-user admin --prompt-password --store-secret encrypted-file

# Purpose: Create a CI profile that reads the token from an environment variable.

grafana-util profile add ci --url https://grafana.example.com --token-env GRAFANA_CI_TOKEN --store-secret os

# Purpose: Print a fully annotated profile template.

grafana-util profile example --mode full

# Purpose: Initialize a fresh grafana-util.yaml in the current checkout.

grafana-util profile init --overwrite

Related commands: grafana-util status live, grafana-util overview live, grafana-util change preview, grafana-util profile current, grafana-util profile validate.

SEE ALSO

grafana-util(1), grafana-util-status(1), grafana-util-overview(1), grafana-util-access(1)