odcli 0.1.3__tar.gz → 0.1.4__tar.gz

{odcli-0.1.3 → odcli-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.3
+Version: 0.1.4
 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
@@ -35,6 +35,7 @@ It works directly on Markdown files inside the vault, so it does not depend on p
 - Append content to a note
 - Full-text search across the vault
 - Auto-discover the default vault from Obsidian config or common macOS and Windows locations
+- Install odcli helper skills into Codex or Claude Code skill directories
 
 ## Using uv
 
@@ -189,6 +190,24 @@ Arguments:
 - `query`
 - `--case-sensitive`
 
+### `plugin install`
+
+Install odcli helper skills for local coding tools.
+
+Targets:
+
+- `codex-skill`: installs to `~/.codex/skills/odcli/SKILL.md`
+- `claude-skill`: installs to `~/.claude/skills/odcli/SKILL.md`
+- `all-skills`: installs both
+
+Examples:
+
+```bash
+odcli plugin install codex-skill
+odcli plugin install claude-skill
+odcli plugin install all-skills
+```
+
 ## Testing
 
 ```bash

{odcli-0.1.3 → odcli-0.1.4}/README.md

@@ -14,6 +14,7 @@ It works directly on Markdown files inside the vault, so it does not depend on p
 - Append content to a note
 - Full-text search across the vault
 - Auto-discover the default vault from Obsidian config or common macOS and Windows locations
+- Install odcli helper skills into Codex or Claude Code skill directories
 
 ## Using uv
 
@@ -168,6 +169,24 @@ Arguments:
 - `query`
 - `--case-sensitive`
 
+### `plugin install`
+
+Install odcli helper skills for local coding tools.
+
+Targets:
+
+- `codex-skill`: installs to `~/.codex/skills/odcli/SKILL.md`
+- `claude-skill`: installs to `~/.claude/skills/odcli/SKILL.md`
+- `all-skills`: installs both
+
+Examples:
+
+```bash
+odcli plugin install codex-skill
+odcli plugin install claude-skill
+odcli plugin install all-skills
+```
+
 ## Testing
 
 ```bash

{odcli-0.1.3 → odcli-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "odcli"
-version = "0.1.3"
+version = "0.1.4"
 description = "A small CLI for reading and writing notes in a local Obsidian vault."
 readme = "README.md"
 requires-python = ">=3.11"

{odcli-0.1.3 → odcli-0.1.4}/src/obsidian_cli/__init__.py

@@ -1,3 +1,3 @@
 __all__ = ["__version__"]
 
-__version__ = "0.1.3"
+__version__ = "0.1.4"

{odcli-0.1.3 → odcli-0.1.4}/src/obsidian_cli/__main__.py

@@ -3,3 +3,4 @@ from obsidian_cli.cli import main
 
 if __name__ == "__main__":
     raise SystemExit(main())
+

{odcli-0.1.3 → odcli-0.1.4}/src/obsidian_cli/cli.py

@@ -5,18 +5,23 @@ import sys
 
 from obsidian_cli.commands import CommandRunner
 from obsidian_cli.discovery import VaultLocator
+from obsidian_cli.plugins import SkillInstaller
 from obsidian_cli.vault import ObsidianVault, VaultError
 
 
 class ObsidianCLI:
     def __init__(self, vault_locator: VaultLocator | None = None) -> None:
         self._vault_locator = vault_locator or VaultLocator()
+        self._skill_installer = SkillInstaller()
         self._parser = self._build_parser()
 
     def run(self, argv: list[str] | None = None) -> int:
         args = self._parser.parse_args(argv)
 
         try:
+            if args.command == "plugin":
+                return self._run_plugin_command(args)
+
             runner = CommandRunner(
                 ObsidianVault(self._vault_locator.resolve(args.vault))
             )
@@ -145,8 +150,31 @@ class ObsidianCLI:
             help="Use case-sensitive matching.",
         )
 
+        plugin_parser = subparsers.add_parser(
+            "plugin", help="Install odcli helper skills for supported coding tools."
+        )
+        plugin_subparsers = plugin_parser.add_subparsers(
+            dest="plugin_command", required=True
+        )
+        plugin_install_parser = plugin_subparsers.add_parser(
+            "install", help="Install an odcli skill into a supported tool directory."
+        )
+        plugin_install_parser.add_argument(
+            "target",
+            choices=["codex-skill", "claude-skill", "all-skills"],
+            help="Installation target.",
+        )
+
         return parser
 
+    def _run_plugin_command(self, args: argparse.Namespace) -> int:
+        if args.plugin_command == "install":
+            for result in self._skill_installer.install(args.target):
+                print(f"{result.target}: {result.path}")
+            return 0
+        self._parser.error(f"unsupported plugin command: {args.plugin_command}")
+        return 2
+
     @staticmethod
     def _read_content_arg(content: str | None, use_stdin: bool) -> str:
         if content is not None and use_stdin:

odcli-0.1.4/src/obsidian_cli/plugins.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+
+
+SKILL_BODY = """# odcli
+
+Use `odcli` when you need to read or write notes inside a local Obsidian vault.
+
+## What this skill does
+
+- Reads notes from a local Obsidian vault
+- Writes or appends Markdown notes
+- Replaces specific line ranges in a note
+- Searches across Markdown notes in the vault
+- Works with either `odcli` or `obsidian-cli`
+
+## Preferred workflow
+
+1. Check whether `OBSIDIAN_VAULT` is set.
+2. If it is not set, let `odcli` auto-discover the vault from local Obsidian config or common default locations.
+3. Use `odcli` for direct note operations instead of editing vault files manually.
+
+## Common commands
+
+```bash
+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"
+```
+
+## Notes
+
+- `--vault /path/to/vault` overrides auto-discovery.
+- `OBSIDIAN_VAULT` is used when set.
+- Line numbers for `read-lines` and `write-lines` are 1-based and inclusive.
+"""
+
+
+@dataclass(frozen=True, slots=True)
+class InstallResult:
+    target: str
+    path: Path
+
+
+class SkillInstaller:
+    def __init__(self, home: Path | None = None) -> None:
+        self._home = (home or Path.home()).expanduser()
+
+    def install(self, target: str) -> list[InstallResult]:
+        if target == "codex-skill":
+            return [
+                self._install_skill(
+                    "codex-skill", self._home / ".codex" / "skills" / "odcli"
+                )
+            ]
+        if target == "claude-skill":
+            return [
+                self._install_skill(
+                    "claude-skill", self._home / ".claude" / "skills" / "odcli"
+                )
+            ]
+        if target == "all-skills":
+            return [
+                self._install_skill(
+                    "codex-skill", self._home / ".codex" / "skills" / "odcli"
+                ),
+                self._install_skill(
+                    "claude-skill", self._home / ".claude" / "skills" / "odcli"
+                ),
+            ]
+        raise ValueError(f"unsupported plugin install target: {target}")
+
+    def _install_skill(self, target: str, skill_dir: Path) -> InstallResult:
+        skill_dir.mkdir(parents=True, exist_ok=True)
+        skill_file = skill_dir / "SKILL.md"
+        skill_file.write_text(SKILL_BODY, encoding="utf-8")
+        return InstallResult(target=target, path=skill_file)

{odcli-0.1.3 → odcli-0.1.4}/src/odcli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.3
+Version: 0.1.4
 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
@@ -35,6 +35,7 @@ It works directly on Markdown files inside the vault, so it does not depend on p
 - Append content to a note
 - Full-text search across the vault
 - Auto-discover the default vault from Obsidian config or common macOS and Windows locations
+- Install odcli helper skills into Codex or Claude Code skill directories
 
 ## Using uv
 
@@ -189,6 +190,24 @@ Arguments:
 - `query`
 - `--case-sensitive`
 
+### `plugin install`
+
+Install odcli helper skills for local coding tools.
+
+Targets:
+
+- `codex-skill`: installs to `~/.codex/skills/odcli/SKILL.md`
+- `claude-skill`: installs to `~/.claude/skills/odcli/SKILL.md`
+- `all-skills`: installs both
+
+Examples:
+
+```bash
+odcli plugin install codex-skill
+odcli plugin install claude-skill
+odcli plugin install all-skills
+```
+
 ## Testing
 
 ```bash

{odcli-0.1.3 → odcli-0.1.4}/src/odcli.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ src/obsidian_cli/__main__.py
 src/obsidian_cli/cli.py
 src/obsidian_cli/commands.py
 src/obsidian_cli/discovery.py
+src/obsidian_cli/plugins.py
 src/obsidian_cli/vault.py
 src/odcli.egg-info/PKG-INFO
 src/odcli.egg-info/SOURCES.txt

{odcli-0.1.3 → odcli-0.1.4}/tests/test_cli.py

@@ -12,6 +12,7 @@ sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "src"))
 
 from obsidian_cli.cli import ObsidianCLI, main
 from obsidian_cli.discovery import VaultCandidate, VaultLocator
+from obsidian_cli.plugins import SkillInstaller
 from obsidian_cli.vault import ObsidianVault, VaultError
 
 
@@ -132,6 +133,33 @@ class VaultTests(unittest.TestCase):
             exit_code = cli.run(["check"])
         self.assertEqual(exit_code, 0)
 
+    def test_skill_installer_installs_codex_skill(self) -> None:
+        installer = SkillInstaller(home=self.vault_root)
+        results = installer.install("codex-skill")
+        self.assertEqual(len(results), 1)
+        self.assertTrue(
+            (self.vault_root / ".codex" / "skills" / "odcli" / "SKILL.md").is_file()
+        )
+
+    def test_skill_installer_installs_claude_skill(self) -> None:
+        installer = SkillInstaller(home=self.vault_root)
+        results = installer.install("claude-skill")
+        self.assertEqual(len(results), 1)
+        self.assertTrue(
+            (self.vault_root / ".claude" / "skills" / "odcli" / "SKILL.md").is_file()
+        )
+
+    def test_cli_plugin_install_all_skills(self) -> None:
+        cli = ObsidianCLI(vault_locator=VaultLocator(env={}, home=self.vault_root))
+        cli._skill_installer = SkillInstaller(home=self.vault_root)
+        stdout = StringIO()
+        with redirect_stdout(stdout), redirect_stderr(StringIO()):
+            exit_code = cli.run(["plugin", "install", "all-skills"])
+        self.assertEqual(exit_code, 0)
+        output = stdout.getvalue()
+        self.assertIn("codex-skill:", output)
+        self.assertIn("claude-skill:", output)
+
 
 if __name__ == "__main__":
     unittest.main()