CLI Aliases Resource

CLIAliasesResource(cli)

Bases: BaseCLIResource

CLI resource for note alias operations.

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

get(path) async

Get the aliases for a file.

Parameters:

Name	Type	Description	Default
path	str	Path to the file relative to the vault root.	required

Returns:

Type	Description
list[str]	List of alias strings for the file.

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

async def get(self, path: str) -> list[str]:
    """Get the aliases for a file.

    Args:
        path: Path to the file relative to the vault root.

    Returns:
        List of alias strings for the file.
    """
    output = await self._cli._execute("aliases", params={"file": path})
    result: list[str] = json.loads(output)
    return result