yera.cli.commands.get

Get commands — inspect resolved config values.

Symbols

def cred — Print the plain value of a single credential leaf.

def cred_group — Show active credential group or inspect a named group's metadata.

def cred_groups — List all credential groups with credential counts and authorised roots.

def creds — Inspect credentials for the active credential group.

def hub — Print one hub's config as JSON.

def hubs — Print every hub entry from config as JSON.

def model — Print all entries for a model id visible under the active Yera profile as JSON.

def models — Print all models visible under the active Yera profile as JSON.

def profile — Print the currently active Yera profile as JSON.

def profiles — Print all configured Yera profiles as JSON.

def provider — Print one provider's config including all connections as JSON.

def providers — Print all configured providers as JSON.

def setting — Print the resolved value of a single setting.

def settings — Print all resolved settings and the resolved default hub name.

cred

cred(
    key: str,
    allow_missing: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print the plain value of a single credential leaf.

Parameters

key

type: str

Exact dotted leaf key.

allow_missing

type: Annotated[bool, Parameter(negative='')] = False

Exit 0 and print nothing if the key is absent.

cred_group

cred_group(
    name: str | None = None,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Show active credential group or inspect a named group's metadata.

Parameters

name

type: str | None = None

Credential group name to inspect. If omitted, prints the active group name. If provided, prints the named group's metadata as JSON.

cred_groups

cred_groups(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

List all credential groups with credential counts and authorised roots.

creds

creds(
    path: str | None = None,
    keys_only: Annotated[bool, Parameter(negative='')] = False,
    reveal: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Inspect credentials for the active credential group.

Parameters

path

type: str | None = None

Dotted path prefix to scope the output. Omit for all credentials in the active group.

keys_only

type: Annotated[bool, Parameter(negative='')] = False

Print key names only.

reveal

type: Annotated[bool, Parameter(negative='')] = False

Show real credential values instead of ***.

hub

hub(
    hub_name: str | None = None,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print one hub's config as JSON.

Parameters

hub_name

type: str | None = None

Hub name to inspect. If omitted, uses the resolved default hub (pyproject.toml [tool.yera] hub, then yera.toml [hubs] default).

hubs

hubs(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print every hub entry from config as JSON.

model

model(
    model_id: Annotated[str, Parameter(help='Yera model id, e.g. aws.meta.llama3.')],
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print all entries for a model id visible under the active Yera profile as JSON.

Since the same model id can exist under multiple connections, all matching entries visible in the active profile are printed.

Parameters

model_id

type: Annotated[str, Parameter(help='Yera model id, e.g. aws.meta.llama3.')]

Yera-internal dot-delimited model id, e.g. aws.meta.llama3.

models

models(
    model_type: Annotated[Literal['llm', 'tts', 'stt', 'embedding', 'reranker'] | None, Parameter(help='Filter by model type.')] = None,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print all models visible under the active Yera profile as JSON.

Parameters

model_type

type: Annotated[Literal['llm', 'tts', 'stt', 'embedding', 'reranker'] | None, Parameter(help='Filter by model type.')] = None

If set, only models of this type are returned.

profile

profile(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print the currently active Yera profile as JSON.

profiles

profiles(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print all configured Yera profiles as JSON.

provider

provider(
    provider_type: Annotated[Literal['anthropic', 'openai', 'aws', 'azure', 'ollama', 'llama_cpp'], Parameter(help='Provider type to inspect.')],
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print one provider's config including all connections as JSON.

Parameters

provider_type

type: Annotated[Literal['anthropic', 'openai', 'aws', 'azure', 'ollama', 'llama_cpp'], Parameter(help='Provider type to inspect.')]

Provider type to inspect. Must be a configured provider.

providers

providers(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print all configured providers as JSON.

setting

setting(
    setting_name: Annotated[str, Parameter(help=_SETTING_NAME_HELP)],
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print the resolved value of a single setting.

settings

settings(
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Print all resolved settings and the resolved default hub name.

← back to docs