yera.cli.commands.delete

Delete commands — remove config entries and files.

Symbols

def config — Delete yera.toml.

def cred — Delete a single credential leaf by exact key.

def cred_group — Delete a credential group and all its credentials from credentials.json.

def creds — Delete credential leaves under a path within the active credential group.

def hub — Remove a named hub from yera.toml.

def hubs — Remove all hubs and the default hub setting from yera.toml.

def model — Remove one model entry from the universe.

def models — Remove all models from the universe, optionally filtered by type.

def profile — Remove a named Yera profile from yera.toml.

def profiles — Remove all Yera profiles and the active default from yera.toml.

def provider — Remove a provider or one of its connections from yera.toml.

def providers — Remove all providers from yera.toml.

config

config(
    force: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Delete yera.toml.

Parameters

force

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

Must be true; the command refuses to delete without --force.

cred

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

Delete a single credential leaf by exact key.

Parameters

key

type: str

Exact dotted leaf key to delete.

cred_group

cred_group(
    name: str,
    force: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Delete a credential group and all its credentials from credentials.json.

Parameters

name

type: str

Credential group name to delete.

force

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

Must be true; the command refuses to delete without --force.

creds

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

Delete credential leaves under a path within the active credential group.

Parameters

path

type: str | None = None

Dotted path prefix to delete under. Omit to delete all credentials in the active group.

force

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

Must be provided to permit bulk deletion.

hub

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

Remove a named hub from yera.toml.

Parameters

hub_name

type: str

Hub to remove from yera.toml. If it was the default hub, the default is cleared.

hubs

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

Remove all hubs and the default hub setting from yera.toml.

Parameters

force

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

Must be true; the command refuses to delete without --force.

model

model(
    model_id: Annotated[str, Parameter(help='Yera model id to remove.')],
    connection: Annotated[str, Parameter(help='Connection name the model was discovered under. Required since the same model id can exist under multiple connections.')],
    model_type: Annotated[Literal['llm', 'embedding', 'tts', 'stt', 'reranker'], Parameter(help='Model type of the entry to remove.')],
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Remove one model entry from the universe.

Parameters

model_id

type: Annotated[str, Parameter(help='Yera model id to remove.')]

Yera-internal dot-delimited model id to remove.

connection

type: Annotated[str, Parameter(help='Connection name the model was discovered under. Required since the same model id can exist under multiple connections.')]

Connection name the model was discovered under. Required because the same model id can exist under multiple connections.

model_type

type: Annotated[Literal['llm', 'embedding', 'tts', 'stt', 'reranker'], Parameter(help='Model type of the entry to remove.')]

Model type of the entry to remove.

models

models(
    model_type: Annotated[Literal['llm', 'embedding', 'tts', 'stt', 'reranker'] | None, Parameter(help='If set, remove only models of this type.')] = None,
    force: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Remove all models from the universe, optionally filtered by type.

Parameters

model_type

type: Annotated[Literal['llm', 'embedding', 'tts', 'stt', 'reranker'] | None, Parameter(help='If set, remove only models of this type.')] = None

If set, only models of this type are removed. If omitted, all models across all types are removed.

force

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

Must be true; the command refuses to delete without --force.

profile

profile(
    profile_name: Annotated[str, Parameter(help='Yera profile name to remove.')],
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Remove a named Yera profile from yera.toml.

Parameters

profile_name

type: Annotated[str, Parameter(help='Yera profile name to remove.')]

Profile to remove. If it was the active default profile, the default is cleared.

profiles

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

Remove all Yera profiles and the active default from yera.toml.

Parameters

force

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

Must be true; the command refuses to delete without --force.

provider

provider(
    provider_type: Annotated[Literal['anthropic', 'openai', 'aws', 'azure', 'ollama', 'llama_cpp'], Parameter(help='Provider type to remove.')],
    connection: Annotated[str | None, Parameter(help='If set, remove only this connection rather than the entire provider. Raises an error if any Yera profile references this connection.')] = None,
    force: Annotated[bool, Parameter(negative='')] = False,
    ctx: Annotated[AppContext, Parameter(parse=False, show=False)],
) → None

Remove a provider or one of its connections from yera.toml.

Parameters

provider_type

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

Provider type to remove. Must be a configured provider.

connection

type: Annotated[str | None, Parameter(help='If set, remove only this connection rather than the entire provider. Raises an error if any Yera profile references this connection.')] = None

If set, remove only this connection. Raises an error if any Yera profile references it — update or remove those profiles first.

force

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

Required when removing an entire provider. The command refuses to delete without --force.

providers

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

Remove all providers from yera.toml.

Parameters

force

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

Must be true; the command refuses to delete without --force.

← back to docs