odcli 0.1.0__tar.gz → 0.1.2__tar.gz

{odcli-0.1.0 → odcli-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.0
+Version: 0.1.2
 Summary: A small CLI for reading and writing notes in a local Obsidian vault.
 Author: Chang LeHung
 Project-URL: Homepage, https://github.com/Chang-LeHung/obsidian-cli
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 uv sync
-uv run obsidian-cli --help
+uv run odcli --help
 ```
 
 运行测试：
@@ -56,9 +56,17 @@ uv build
 ```
 
 发布到 PyPI 后，安装包名会是 `odcli`。
+安装后可执行命令同时支持 `odcli` 和 `obsidian-cli`。
 
 ## 直接运行
 
+```bash
+cd /Users/huchang/agents/obsidian_cli
+./odcli --help
+```
+
+兼容入口仍然保留：
+
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 ./obsidian-cli --help
@@ -85,19 +93,29 @@ uv sync
 
 1. `--vault /path/to/vault`
 2. 环境变量 `OBSIDIAN_VAULT`
+3. Obsidian 本地配置里最近打开的 vault
+4. 常见默认目录
+
+当前内置的默认目录包括：
+
+- macOS: `~/Documents/Obsidian Vault`
+- macOS: `~/Documents/Obsidian`
+- macOS iCloud: `~/Library/Mobile Documents/iCloud~md~obsidian/Documents`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian Vault`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian`
 
 示例：
 
 ```bash
 export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./obsidian-cli check
-./obsidian-cli list
-./obsidian-cli read Inbox/today.md
-./obsidian-cli read-lines Inbox/today.md 3 8
-./obsidian-cli write Inbox/today.md --content "# Today"
-./obsidian-cli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
-./obsidian-cli append Inbox/today.md --content "\n- new item"
-./obsidian-cli search "project alpha"
+./odcli check
+./odcli list
+./odcli read Inbox/today.md
+./odcli read-lines Inbox/today.md 3 8
+./odcli write Inbox/today.md --content "# Today"
+./odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+./odcli append Inbox/today.md --content "\n- new item"
+./odcli search "project alpha"
 ```
 
 ## 命令

{odcli-0.1.0 → odcli-0.1.2}/README.md

@@ -18,7 +18,7 @@
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 uv sync
-uv run obsidian-cli --help
+uv run odcli --help
 ```
 
 运行测试：
@@ -36,9 +36,17 @@ uv build
 ```
 
 发布到 PyPI 后，安装包名会是 `odcli`。
+安装后可执行命令同时支持 `odcli` 和 `obsidian-cli`。
 
 ## 直接运行
 
+```bash
+cd /Users/huchang/agents/obsidian_cli
+./odcli --help
+```
+
+兼容入口仍然保留：
+
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 ./obsidian-cli --help
@@ -65,19 +73,29 @@ uv sync
 
 1. `--vault /path/to/vault`
 2. 环境变量 `OBSIDIAN_VAULT`
+3. Obsidian 本地配置里最近打开的 vault
+4. 常见默认目录
+
+当前内置的默认目录包括：
+
+- macOS: `~/Documents/Obsidian Vault`
+- macOS: `~/Documents/Obsidian`
+- macOS iCloud: `~/Library/Mobile Documents/iCloud~md~obsidian/Documents`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian Vault`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian`
 
 示例：
 
 ```bash
 export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./obsidian-cli check
-./obsidian-cli list
-./obsidian-cli read Inbox/today.md
-./obsidian-cli read-lines Inbox/today.md 3 8
-./obsidian-cli write Inbox/today.md --content "# Today"
-./obsidian-cli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
-./obsidian-cli append Inbox/today.md --content "\n- new item"
-./obsidian-cli search "project alpha"
+./odcli check
+./odcli list
+./odcli read Inbox/today.md
+./odcli read-lines Inbox/today.md 3 8
+./odcli write Inbox/today.md --content "# Today"
+./odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+./odcli append Inbox/today.md --content "\n- new item"
+./odcli search "project alpha"
 ```
 
 ## 命令

{odcli-0.1.0 → odcli-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "odcli"
-version = "0.1.0"
+version = "0.1.2"
 description = "A small CLI for reading and writing notes in a local Obsidian vault."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -30,6 +30,7 @@ Repository = "https://github.com/Chang-LeHung/obsidian-cli"
 Issues = "https://github.com/Chang-LeHung/obsidian-cli/issues"
 
 [project.scripts]
+odcli = "obsidian_cli.cli:main"
 obsidian-cli = "obsidian_cli.cli:main"
 
 [dependency-groups]

{odcli-0.1.0 → odcli-0.1.2}/src/obsidian_cli/cli.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import argparse
+import json
 import os
 import sys
 from pathlib import Path
@@ -71,9 +72,86 @@ def build_parser() -> argparse.ArgumentParser:
 
 def resolve_vault_path(cli_value: str | None) -> Path:
     raw_value = cli_value or os.environ.get("OBSIDIAN_VAULT")
-    if not raw_value:
-        raise VaultError("vault path is required; use --vault or OBSIDIAN_VAULT")
-    return Path(raw_value)
+    if raw_value:
+        return Path(raw_value)
+
+    discovered = discover_default_vault_path()
+    if discovered is not None:
+        return discovered
+
+    raise VaultError(
+        "vault path is required; use --vault, OBSIDIAN_VAULT, or place your vault in a default Obsidian location"
+    )
+
+
+def discover_default_vault_path() -> Path | None:
+    vault_from_config = discover_vault_from_obsidian_config()
+    if vault_from_config is not None:
+        return vault_from_config
+
+    for candidate in iter_default_vault_candidates():
+        if (candidate / ".obsidian").is_dir():
+            return candidate
+    return None
+
+
+def discover_vault_from_obsidian_config() -> Path | None:
+    for config_path in iter_obsidian_config_paths():
+        if not config_path.is_file():
+            continue
+        try:
+            payload = json.loads(config_path.read_text(encoding="utf-8"))
+        except (OSError, json.JSONDecodeError):
+            continue
+
+        vaults = payload.get("vaults")
+        if not isinstance(vaults, dict):
+            continue
+
+        candidates: list[tuple[int, str]] = []
+        for item in vaults.values():
+            if not isinstance(item, dict):
+                continue
+            path_value = item.get("path")
+            if not isinstance(path_value, str):
+                continue
+            ts_value = item.get("ts")
+            timestamp = ts_value if isinstance(ts_value, int) else -1
+            candidates.append((timestamp, path_value))
+
+        for _, path_value in sorted(candidates, reverse=True):
+            candidate = Path(path_value).expanduser()
+            if (candidate / ".obsidian").is_dir():
+                return candidate
+
+    return None
+
+
+def iter_obsidian_config_paths() -> list[Path]:
+    home = Path.home()
+    appdata = os.environ.get("APPDATA")
+    candidates = [
+        home / "Library" / "Application Support" / "obsidian" / "obsidian.json",
+        home / ".config" / "obsidian" / "obsidian.json",
+    ]
+    if appdata:
+        candidates.append(Path(appdata) / "obsidian" / "obsidian.json")
+    else:
+        candidates.append(
+            home / "AppData" / "Roaming" / "obsidian" / "obsidian.json"
+        )
+    return candidates
+
+
+def iter_default_vault_candidates() -> list[Path]:
+    home = Path.home()
+    return [
+        home / "Documents" / "Obsidian Vault",
+        home / "Documents" / "Obsidian",
+        home / "Library" / "Mobile Documents" / "iCloud~md~obsidian" / "Documents",
+        home / "AppData" / "Roaming" / "Obsidian",
+        home / "AppData" / "Roaming" / "obsidian" / "vaults" / "default",
+    ]
 
 
 def read_content_arg(content: str | None, use_stdin: bool) -> str:

{odcli-0.1.0 → odcli-0.1.2}/src/odcli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.0
+Version: 0.1.2
 Summary: A small CLI for reading and writing notes in a local Obsidian vault.
 Author: Chang LeHung
 Project-URL: Homepage, https://github.com/Chang-LeHung/obsidian-cli
@@ -38,7 +38,7 @@ Description-Content-Type: text/markdown
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 uv sync
-uv run obsidian-cli --help
+uv run odcli --help
 ```
 
 运行测试：
@@ -56,9 +56,17 @@ uv build
 ```
 
 发布到 PyPI 后，安装包名会是 `odcli`。
+安装后可执行命令同时支持 `odcli` 和 `obsidian-cli`。
 
 ## 直接运行
 
+```bash
+cd /Users/huchang/agents/obsidian_cli
+./odcli --help
+```
+
+兼容入口仍然保留：
+
 ```bash
 cd /Users/huchang/agents/obsidian_cli
 ./obsidian-cli --help
@@ -85,19 +93,29 @@ uv sync
 
 1. `--vault /path/to/vault`
 2. 环境变量 `OBSIDIAN_VAULT`
+3. Obsidian 本地配置里最近打开的 vault
+4. 常见默认目录
+
+当前内置的默认目录包括：
+
+- macOS: `~/Documents/Obsidian Vault`
+- macOS: `~/Documents/Obsidian`
+- macOS iCloud: `~/Library/Mobile Documents/iCloud~md~obsidian/Documents`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian Vault`
+- Windows: `%USERPROFILE%\\Documents\\Obsidian`
 
 示例：
 
 ```bash
 export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./obsidian-cli check
-./obsidian-cli list
-./obsidian-cli read Inbox/today.md
-./obsidian-cli read-lines Inbox/today.md 3 8
-./obsidian-cli write Inbox/today.md --content "# Today"
-./obsidian-cli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
-./obsidian-cli append Inbox/today.md --content "\n- new item"
-./obsidian-cli search "project alpha"
+./odcli check
+./odcli list
+./odcli read Inbox/today.md
+./odcli read-lines Inbox/today.md 3 8
+./odcli write Inbox/today.md --content "# Today"
+./odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+./odcli append Inbox/today.md --content "\n- new item"
+./odcli search "project alpha"
 ```
 
 ## 命令

{odcli-0.1.0 → odcli-0.1.2}/src/odcli.egg-info/entry_points.txt

@@ -1,2 +1,3 @@
 [console_scripts]
 obsidian-cli = obsidian_cli.cli:main
+odcli = obsidian_cli.cli:main

{odcli-0.1.0 → odcli-0.1.2}/tests/test_cli.py

@@ -6,9 +6,11 @@ from pathlib import Path
 import sys
 from contextlib import redirect_stderr, redirect_stdout
 from io import StringIO
+from unittest.mock import patch
 
 sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
 
+from obsidian_cli import cli
 from obsidian_cli.cli import main
 from obsidian_cli.vault import ObsidianVault, VaultError
 
@@ -93,6 +95,27 @@ class VaultTests(unittest.TestCase):
         self.assertEqual(exit_code, 0)
         self.assertEqual(self.vault.read_note("Note.md"), "a\nbeta\nc\n")
 
+    def test_resolve_vault_path_prefers_env_var(self) -> None:
+        with patch.dict("os.environ", {"OBSIDIAN_VAULT": str(self.vault_root)}, clear=False):
+            resolved = cli.resolve_vault_path(None)
+        self.assertEqual(resolved, self.vault_root)
+
+    def test_resolve_vault_path_discovers_default_vault(self) -> None:
+        with patch.dict("os.environ", {}, clear=True):
+            with patch.object(cli, "discover_vault_from_obsidian_config", return_value=None):
+                with patch.object(cli, "iter_default_vault_candidates", return_value=[self.vault_root]):
+                    resolved = cli.resolve_vault_path(None)
+        self.assertEqual(resolved, self.vault_root)
+
+    def test_resolve_vault_path_uses_obsidian_config_first(self) -> None:
+        config_vault = self.vault_root / "Configured"
+        config_vault.mkdir()
+        (config_vault / ".obsidian").mkdir()
+        with patch.dict("os.environ", {}, clear=True):
+            with patch.object(cli, "discover_vault_from_obsidian_config", return_value=config_vault):
+                resolved = cli.resolve_vault_path(None)
+        self.assertEqual(resolved, config_vault)
+
 
 if __name__ == "__main__":
     unittest.main()