odcli 0.1.4__tar.gz → 0.1.6__tar.gz

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

@@ -1,11 +1,8 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.4
+Version: 0.1.6
 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
-Project-URL: Repository, https://github.com/Chang-LeHung/obsidian-cli
-Project-URL: Issues, https://github.com/Chang-LeHung/obsidian-cli/issues
+Author: odcli contributors
 Keywords: obsidian,cli,markdown,notes,vault
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -21,68 +18,119 @@ Description-Content-Type: text/markdown
 
 # odcli
 
-`odcli` is a local Python CLI for reading and writing notes in an Obsidian vault.
-It works directly on Markdown files inside the vault, so it does not depend on private Obsidian APIs and remains portable and easy to extend.
+`odcli` is a command-line tool for reading and writing notes in a local Obsidian vault.
 
-## Features
+It works directly on Markdown files inside the vault, so you can use it without any private Obsidian API.
 
-- Validate whether a vault path is available
-- List Markdown notes in the vault
-- Read a specific note
-- Read a specific line range from a note
-- Overwrite a note or create it automatically
-- Replace a specific line range in a note
-- 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
+## Install
 
-## Using uv
+From PyPI:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv sync
-uv run odcli --help
+pip install odcli
 ```
 
-Run tests:
+Or with `uv`:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
+uv tool install odcli
 ```
 
-Build distributions:
+After installation, both command names are available:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv build
+odcli --help
+obsidian-cli --help
+```
+
+## Quickstart
+
+If your vault is already in a common location, `odcli` can usually find it automatically:
+
+```bash
+odcli check
+odcli list
+```
+
+If you want to set the vault explicitly:
+
+```bash
+export OBSIDIAN_VAULT="/path/to/MyVault"
+odcli check
+```
+
+You can also override the vault per command:
+
+```bash
+odcli --vault "/path/to/MyVault" list
 ```
 
-The published package name on PyPI is `odcli`.
-After installation, both `odcli` and `obsidian-cli` are available as command names.
+## Common Commands
 
-## Run Locally
+Read a note:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-./odcli --help
+odcli read Inbox/today.md
 ```
 
-The compatibility entry point is still available:
+Read specific lines:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-./obsidian-cli --help
+odcli read-lines Inbox/today.md 3 8
 ```
 
-If you prefer module execution:
+Create or overwrite a note:
 
 ```bash
-PYTHONPATH=src python3 -m obsidian_cli --help
+odcli write Inbox/today.md --content "# Today"
 ```
 
-## Vault Resolution
+Replace a line range:
+
+```bash
+odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+```
+
+Append content:
+
+```bash
+odcli append Inbox/today.md --content "\n- new item"
+```
+
+Search across the vault:
+
+```bash
+odcli search "project alpha"
+```
+
+## Skill Install
+
+`odcli` can install helper skills for local coding tools.
+
+Install into Codex:
+
+```bash
+odcli plugin install codex-skill
+```
+
+Install into Claude Code:
+
+```bash
+odcli plugin install claude-skill
+```
+
+Install both:
+
+```bash
+odcli plugin install all-skills
+```
+
+Installed paths:
+
+- Codex: `~/.codex/skills/odcli/SKILL.md`
+- Claude Code: `~/.claude/skills/odcli/SKILL.md`
+
+## Vault Discovery
 
 Resolution priority:
 
@@ -99,21 +147,7 @@ Built-in default locations:
 - Windows: `%USERPROFILE%\\Documents\\Obsidian Vault`
 - Windows: `%USERPROFILE%\\Documents\\Obsidian`
 
-Example:
-
-```bash
-export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./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"
-```
-
-## Commands
+## Command Summary
 
 ### `check`
 
@@ -190,27 +224,26 @@ Arguments:
 - `query`
 - `--case-sensitive`
 
-### `plugin install`
-
-Install odcli helper skills for local coding tools.
+## For Developers
 
-Targets:
+Run from source:
 
-- `codex-skill`: installs to `~/.codex/skills/odcli/SKILL.md`
-- `claude-skill`: installs to `~/.claude/skills/odcli/SKILL.md`
-- `all-skills`: installs both
+```bash
+cd path/to/obsidian_cli
+uv sync
+uv run odcli --help
+```
 
-Examples:
+Run tests:
 
 ```bash
-odcli plugin install codex-skill
-odcli plugin install claude-skill
-odcli plugin install all-skills
+cd path/to/obsidian_cli
+uv run python -m unittest discover -s tests
 ```
 
-## Testing
+Build distributions:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
+cd path/to/obsidian_cli
+uv build
 ```

odcli-0.1.6/README.md

@@ -0,0 +1,231 @@
+# odcli
+
+`odcli` is a command-line tool for reading and writing notes in a local Obsidian vault.
+
+It works directly on Markdown files inside the vault, so you can use it without any private Obsidian API.
+
+## Install
+
+From PyPI:
+
+```bash
+pip install odcli
+```
+
+Or with `uv`:
+
+```bash
+uv tool install odcli
+```
+
+After installation, both command names are available:
+
+```bash
+odcli --help
+obsidian-cli --help
+```
+
+## Quickstart
+
+If your vault is already in a common location, `odcli` can usually find it automatically:
+
+```bash
+odcli check
+odcli list
+```
+
+If you want to set the vault explicitly:
+
+```bash
+export OBSIDIAN_VAULT="/path/to/MyVault"
+odcli check
+```
+
+You can also override the vault per command:
+
+```bash
+odcli --vault "/path/to/MyVault" list
+```
+
+## Common Commands
+
+Read a note:
+
+```bash
+odcli read Inbox/today.md
+```
+
+Read specific lines:
+
+```bash
+odcli read-lines Inbox/today.md 3 8
+```
+
+Create or overwrite a note:
+
+```bash
+odcli write Inbox/today.md --content "# Today"
+```
+
+Replace a line range:
+
+```bash
+odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+```
+
+Append content:
+
+```bash
+odcli append Inbox/today.md --content "\n- new item"
+```
+
+Search across the vault:
+
+```bash
+odcli search "project alpha"
+```
+
+## Skill Install
+
+`odcli` can install helper skills for local coding tools.
+
+Install into Codex:
+
+```bash
+odcli plugin install codex-skill
+```
+
+Install into Claude Code:
+
+```bash
+odcli plugin install claude-skill
+```
+
+Install both:
+
+```bash
+odcli plugin install all-skills
+```
+
+Installed paths:
+
+- Codex: `~/.codex/skills/odcli/SKILL.md`
+- Claude Code: `~/.claude/skills/odcli/SKILL.md`
+
+## Vault Discovery
+
+Resolution priority:
+
+1. `--vault /path/to/vault`
+2. `OBSIDIAN_VAULT`
+3. The most recently opened vault recorded by local Obsidian config
+4. Common default directories
+
+Built-in default locations:
+
+- 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`
+
+## Command Summary
+
+### `check`
+
+Validate that the vault exists and report whether `.obsidian` is present.
+
+### `list`
+
+List Markdown notes in the vault.
+
+Optional arguments:
+
+- `--limit N`
+
+### `read`
+
+Read a note.
+
+Arguments:
+
+- `note_path`: path relative to the vault root
+
+### `write`
+
+Overwrite a note. Parent directories are created automatically if needed.
+
+Arguments:
+
+- `note_path`
+- `--content TEXT`
+- `--stdin`
+
+Optional arguments:
+
+- `--create-only`
+
+### `read-lines`
+
+Read a line range. Line numbers are 1-based and inclusive.
+
+Arguments:
+
+- `note_path`
+- `start_line`
+- `end_line`
+
+### `write-lines`
+
+Replace a line range. Line numbers are 1-based and inclusive.
+
+Arguments:
+
+- `note_path`
+- `start_line`
+- `end_line`
+- `--content TEXT`
+- `--stdin`
+
+### `append`
+
+Append content to the end of a note.
+
+Arguments:
+
+- `note_path`
+- `--content TEXT`
+- `--stdin`
+
+### `search`
+
+Search across all Markdown notes in the vault.
+
+Arguments:
+
+- `query`
+- `--case-sensitive`
+
+## For Developers
+
+Run from source:
+
+```bash
+cd path/to/obsidian_cli
+uv sync
+uv run odcli --help
+```
+
+Run tests:
+
+```bash
+cd path/to/obsidian_cli
+uv run python -m unittest discover -s tests
+```
+
+Build distributions:
+
+```bash
+cd path/to/obsidian_cli
+uv build
+```

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

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "odcli"
-version = "0.1.4"
+version = "0.1.6"
 description = "A small CLI for reading and writing notes in a local Obsidian vault."
 readme = "README.md"
 requires-python = ">=3.11"
 authors = [
-  { name = "Chang LeHung" }
+  { name = "odcli contributors" }
 ]
 dependencies = []
 keywords = ["obsidian", "cli", "markdown", "notes", "vault"]
@@ -25,11 +25,6 @@ classifiers = [
   "Environment :: Console",
 ]
 
-[project.urls]
-Homepage = "https://github.com/Chang-LeHung/obsidian-cli"
-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"

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

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

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

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

{odcli-0.1.4 → odcli-0.1.6}/src/obsidian_cli/plugins.py

@@ -4,7 +4,12 @@ from dataclasses import dataclass
 from pathlib import Path
 
 
-SKILL_BODY = """# odcli
+SKILL_BODY = """---
+name: "odcli"
+description: "Use odcli to read, write, append, search, and patch notes inside a local Obsidian vault."
+---
+
+# odcli
 
 Use `odcli` when you need to read or write notes inside a local Obsidian vault.
 

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

@@ -1,11 +1,8 @@
 Metadata-Version: 2.4
 Name: odcli
-Version: 0.1.4
+Version: 0.1.6
 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
-Project-URL: Repository, https://github.com/Chang-LeHung/obsidian-cli
-Project-URL: Issues, https://github.com/Chang-LeHung/obsidian-cli/issues
+Author: odcli contributors
 Keywords: obsidian,cli,markdown,notes,vault
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -21,68 +18,119 @@ Description-Content-Type: text/markdown
 
 # odcli
 
-`odcli` is a local Python CLI for reading and writing notes in an Obsidian vault.
-It works directly on Markdown files inside the vault, so it does not depend on private Obsidian APIs and remains portable and easy to extend.
+`odcli` is a command-line tool for reading and writing notes in a local Obsidian vault.
 
-## Features
+It works directly on Markdown files inside the vault, so you can use it without any private Obsidian API.
 
-- Validate whether a vault path is available
-- List Markdown notes in the vault
-- Read a specific note
-- Read a specific line range from a note
-- Overwrite a note or create it automatically
-- Replace a specific line range in a note
-- 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
+## Install
 
-## Using uv
+From PyPI:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv sync
-uv run odcli --help
+pip install odcli
 ```
 
-Run tests:
+Or with `uv`:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
+uv tool install odcli
 ```
 
-Build distributions:
+After installation, both command names are available:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv build
+odcli --help
+obsidian-cli --help
+```
+
+## Quickstart
+
+If your vault is already in a common location, `odcli` can usually find it automatically:
+
+```bash
+odcli check
+odcli list
+```
+
+If you want to set the vault explicitly:
+
+```bash
+export OBSIDIAN_VAULT="/path/to/MyVault"
+odcli check
+```
+
+You can also override the vault per command:
+
+```bash
+odcli --vault "/path/to/MyVault" list
 ```
 
-The published package name on PyPI is `odcli`.
-After installation, both `odcli` and `obsidian-cli` are available as command names.
+## Common Commands
 
-## Run Locally
+Read a note:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-./odcli --help
+odcli read Inbox/today.md
 ```
 
-The compatibility entry point is still available:
+Read specific lines:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-./obsidian-cli --help
+odcli read-lines Inbox/today.md 3 8
 ```
 
-If you prefer module execution:
+Create or overwrite a note:
 
 ```bash
-PYTHONPATH=src python3 -m obsidian_cli --help
+odcli write Inbox/today.md --content "# Today"
 ```
 
-## Vault Resolution
+Replace a line range:
+
+```bash
+odcli write-lines Inbox/today.md 3 4 --content "- replaced\n- lines\n"
+```
+
+Append content:
+
+```bash
+odcli append Inbox/today.md --content "\n- new item"
+```
+
+Search across the vault:
+
+```bash
+odcli search "project alpha"
+```
+
+## Skill Install
+
+`odcli` can install helper skills for local coding tools.
+
+Install into Codex:
+
+```bash
+odcli plugin install codex-skill
+```
+
+Install into Claude Code:
+
+```bash
+odcli plugin install claude-skill
+```
+
+Install both:
+
+```bash
+odcli plugin install all-skills
+```
+
+Installed paths:
+
+- Codex: `~/.codex/skills/odcli/SKILL.md`
+- Claude Code: `~/.claude/skills/odcli/SKILL.md`
+
+## Vault Discovery
 
 Resolution priority:
 
@@ -99,21 +147,7 @@ Built-in default locations:
 - Windows: `%USERPROFILE%\\Documents\\Obsidian Vault`
 - Windows: `%USERPROFILE%\\Documents\\Obsidian`
 
-Example:
-
-```bash
-export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./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"
-```
-
-## Commands
+## Command Summary
 
 ### `check`
 
@@ -190,27 +224,26 @@ Arguments:
 - `query`
 - `--case-sensitive`
 
-### `plugin install`
-
-Install odcli helper skills for local coding tools.
+## For Developers
 
-Targets:
+Run from source:
 
-- `codex-skill`: installs to `~/.codex/skills/odcli/SKILL.md`
-- `claude-skill`: installs to `~/.claude/skills/odcli/SKILL.md`
-- `all-skills`: installs both
+```bash
+cd path/to/obsidian_cli
+uv sync
+uv run odcli --help
+```
 
-Examples:
+Run tests:
 
 ```bash
-odcli plugin install codex-skill
-odcli plugin install claude-skill
-odcli plugin install all-skills
+cd path/to/obsidian_cli
+uv run python -m unittest discover -s tests
 ```
 
-## Testing
+Build distributions:
 
 ```bash
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
+cd path/to/obsidian_cli
+uv build
 ```

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

@@ -137,17 +137,17 @@ class VaultTests(unittest.TestCase):
         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()
-        )
+        skill_path = self.vault_root / ".codex" / "skills" / "odcli" / "SKILL.md"
+        self.assertTrue(skill_path.is_file())
+        self.assertTrue(skill_path.read_text(encoding="utf-8").startswith("---\n"))
 
     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()
-        )
+        skill_path = self.vault_root / ".claude" / "skills" / "odcli" / "SKILL.md"
+        self.assertTrue(skill_path.is_file())
+        self.assertTrue(skill_path.read_text(encoding="utf-8").startswith("---\n"))
 
     def test_cli_plugin_install_all_skills(self) -> None:
         cli = ObsidianCLI(vault_locator=VaultLocator(env={}, home=self.vault_root))

odcli-0.1.4/README.md

@@ -1,195 +0,0 @@
-# odcli
-
-`odcli` is a local Python CLI for reading and writing notes in an Obsidian vault.
-It works directly on Markdown files inside the vault, so it does not depend on private Obsidian APIs and remains portable and easy to extend.
-
-## Features
-
-- Validate whether a vault path is available
-- List Markdown notes in the vault
-- Read a specific note
-- Read a specific line range from a note
-- Overwrite a note or create it automatically
-- Replace a specific line range in a note
-- 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
-
-```bash
-cd /Users/huchang/agents/obsidian_cli
-uv sync
-uv run odcli --help
-```
-
-Run tests:
-
-```bash
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
-```
-
-Build distributions:
-
-```bash
-cd /Users/huchang/agents/obsidian_cli
-uv build
-```
-
-The published package name on PyPI is `odcli`.
-After installation, both `odcli` and `obsidian-cli` are available as command names.
-
-## Run Locally
-
-```bash
-cd /Users/huchang/agents/obsidian_cli
-./odcli --help
-```
-
-The compatibility entry point is still available:
-
-```bash
-cd /Users/huchang/agents/obsidian_cli
-./obsidian-cli --help
-```
-
-If you prefer module execution:
-
-```bash
-PYTHONPATH=src python3 -m obsidian_cli --help
-```
-
-## Vault Resolution
-
-Resolution priority:
-
-1. `--vault /path/to/vault`
-2. `OBSIDIAN_VAULT`
-3. The most recently opened vault recorded by local Obsidian config
-4. Common default directories
-
-Built-in default locations:
-
-- 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`
-
-Example:
-
-```bash
-export OBSIDIAN_VAULT="/Users/your-name/Documents/MyVault"
-./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"
-```
-
-## Commands
-
-### `check`
-
-Validate that the vault exists and report whether `.obsidian` is present.
-
-### `list`
-
-List Markdown notes in the vault.
-
-Optional arguments:
-
-- `--limit N`
-
-### `read`
-
-Read a note.
-
-Arguments:
-
-- `note_path`: path relative to the vault root
-
-### `write`
-
-Overwrite a note. Parent directories are created automatically if needed.
-
-Arguments:
-
-- `note_path`
-- `--content TEXT`
-- `--stdin`
-
-Optional arguments:
-
-- `--create-only`
-
-### `read-lines`
-
-Read a line range. Line numbers are 1-based and inclusive.
-
-Arguments:
-
-- `note_path`
-- `start_line`
-- `end_line`
-
-### `write-lines`
-
-Replace a line range. Line numbers are 1-based and inclusive.
-
-Arguments:
-
-- `note_path`
-- `start_line`
-- `end_line`
-- `--content TEXT`
-- `--stdin`
-
-### `append`
-
-Append content to the end of a note.
-
-Arguments:
-
-- `note_path`
-- `--content TEXT`
-- `--stdin`
-
-### `search`
-
-Search across all Markdown notes in the vault.
-
-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
-cd /Users/huchang/agents/obsidian_cli
-uv run python -m unittest discover -s tests
-```