CLI Snippets Resource

CLISnippetsResource(cli)

Bases: BaseCLIResource

CLI resource for CSS snippet management.

Attributes:

Name	Type	Description
_cli		Reference to the parent ObsidianCLI instance.

Source code in src/aiobsidian/cli/_base.py

def __init__(self, cli: ObsidianCLI) -> None:
    self._cli = cli

enabled() async

List enabled CSS snippets.

Returns:

Type	Description
list[dict[str, Any]]	List of enabled snippet objects.

Source code in src/aiobsidian/cli/snippets.py

async def enabled(self) -> list[dict[str, Any]]:
    """List enabled CSS snippets.

    Returns:
        List of enabled snippet objects.
    """
    output = await self._cli._execute("snippets:enabled")
    result: list[dict[str, Any]] = json.loads(output)
    return result

enable(name) async

Enable a CSS snippet.

Parameters:

Name	Type	Description	Default
name	str	Snippet name.	required

Source code in src/aiobsidian/cli/snippets.py

async def enable(self, name: str) -> None:
    """Enable a CSS snippet.

    Args:
        name: Snippet name.
    """
    await self._cli._execute("snippet:enable", params={"name": name})

disable(name) async

Disable a CSS snippet.

Parameters:

Name	Type	Description	Default
name	str	Snippet name.	required

Source code in src/aiobsidian/cli/snippets.py

async def disable(self, name: str) -> None:
    """Disable a CSS snippet.

    Args:
        name: Snippet name.
    """
    await self._cli._execute("snippet:disable", params={"name": name})

list() async

List all CSS snippets.

Returns:

Type	Description
list[dict[str, Any]]	List of snippet objects.

Source code in src/aiobsidian/cli/snippets.py

async def list(self) -> list[dict[str, Any]]:
    """List all CSS snippets.

    Returns:
        List of snippet objects.
    """
    output = await self._cli._execute("snippets")
    result: list[dict[str, Any]] = json.loads(output)
    return result