keep-skill 0.4.1__py3-none-any.whl → 0.6.0__py3-none-any.whl

keep/cli.py

@@ -17,10 +17,13 @@ from typing import Optional
 import typer
 from typing_extensions import Annotated
 
-
 # Pattern for version identifier suffix: @V{N} where N is digits only
 VERSION_SUFFIX_PATTERN = re.compile(r'@V\{(\d+)\}$')
 
+# URI scheme pattern per RFC 3986: scheme = ALPHA *( ALPHA / DIGIT / "+" / "-" / "." )
+# Used to distinguish URIs from plain text in the update command
+_URI_SCHEME_PATTERN = re.compile(r'^[a-zA-Z][a-zA-Z0-9+.-]*://')
+
 from .api import Keeper, _text_content_id
 from .document_store import VersionInfo
 from .types import Item
@@ -82,11 +85,29 @@ app = typer.Typer(
 )
 
 
+# -----------------------------------------------------------------------------
+# Output Formatting
+#
+# Three output formats, controlled by global flags:
+#   --ids:  versioned ID only (id@V{N})
+#   --full: YAML frontmatter with tags, similar items, version nav
+#   default: summary line (id@V{N} date summary)
+#
+# JSON output (--json) works with any of the above.
+# -----------------------------------------------------------------------------
+
+def _filter_display_tags(tags: dict) -> dict:
+    """Filter out internal-only tags for display."""
+    from .types import INTERNAL_TAGS
+    return {k: v for k, v in tags.items() if k not in INTERNAL_TAGS}
+
+
 def _format_yaml_frontmatter(
     item: Item,
     version_nav: Optional[dict[str, list[VersionInfo]]] = None,
     viewing_offset: Optional[int] = None,
     similar_items: Optional[list[Item]] = None,
+    similar_offsets: Optional[dict[str, int]] = None,
 ) -> str:
     """
     Format item as YAML frontmatter with summary as content.
@@ -96,6 +117,7 @@ def _format_yaml_frontmatter(
         version_nav: Optional version navigation info (prev/next lists)
         viewing_offset: If viewing an old version, the offset (1=previous, 2=two ago)
         similar_items: Optional list of similar items to display
+        similar_offsets: Version offsets for similar items (item.id -> offset)
 
     Note: Offset computation (v1, v2, etc.) assumes version_nav lists
     are ordered newest-first, matching list_versions() ordering.
@@ -104,20 +126,27 @@ def _format_yaml_frontmatter(
     lines = ["---", f"id: {item.id}"]
     if viewing_offset is not None:
         lines.append(f"version: {viewing_offset}")
-    if item.tags:
-        tag_items = ", ".join(f"{k}: {v}" for k, v in sorted(item.tags.items()))
+    display_tags = _filter_display_tags(item.tags)
+    if display_tags:
+        tag_items = ", ".join(f"{k}: {v}" for k, v in sorted(display_tags.items()))
         lines.append(f"tags: {{{tag_items}}}")
     if item.score is not None:
         lines.append(f"score: {item.score:.3f}")
 
-    # Add similar items if available
+    # Add similar items if available (version-scoped IDs with date and summary)
     if similar_items:
         lines.append("similar:")
         for sim_item in similar_items:
+            base_id = sim_item.tags.get("_base_id", sim_item.id)
+            offset = (similar_offsets or {}).get(sim_item.id, 0)
             score_str = f"({sim_item.score:.2f})" if sim_item.score else ""
-            lines.append(f"  - {sim_item.id} {score_str}")
+            date_part = sim_item.tags.get("_updated", sim_item.tags.get("_created", ""))[:10]
+            summary_preview = sim_item.summary[:40].replace("\n", " ")
+            if len(sim_item.summary) > 40:
+                summary_preview += "..."
+            lines.append(f"  - {base_id}@V{{{offset}}} {score_str} {date_part} {summary_preview}")
 
-    # Add version navigation if available
+    # Add version navigation (just @V{N} since ID is shown at top, with date + summary)
     if version_nav:
         # Current offset (0 if viewing current)
         current_offset = viewing_offset if viewing_offset is not None else 0
@@ -125,33 +154,56 @@ def _format_yaml_frontmatter(
         if version_nav.get("prev"):
             lines.append("prev:")
             for i, v in enumerate(version_nav["prev"]):
-                # Offset for this prev item: current_offset + i + 1
                 prev_offset = current_offset + i + 1
-                date_part = v.created_at[:10] if v.created_at else "unknown"
+                date_part = v.created_at[:10] if v.created_at else ""
                 summary_preview = v.summary[:40].replace("\n", " ")
                 if len(v.summary) > 40:
                     summary_preview += "..."
-                lines.append(f"  - v{prev_offset}: {date_part} {summary_preview}")
+                lines.append(f"  - @V{{{prev_offset}}} {date_part} {summary_preview}")
         if version_nav.get("next"):
             lines.append("next:")
             for i, v in enumerate(version_nav["next"]):
-                # Offset for this next item: current_offset - i - 1
                 next_offset = current_offset - i - 1
-                date_part = v.created_at[:10] if v.created_at else "unknown"
+                date_part = v.created_at[:10] if v.created_at else ""
                 summary_preview = v.summary[:40].replace("\n", " ")
                 if len(v.summary) > 40:
                     summary_preview += "..."
-                lines.append(f"  - v{next_offset}: {date_part} {summary_preview}")
+                lines.append(f"  - @V{{{next_offset}}} {date_part} {summary_preview}")
         elif viewing_offset is not None:
             # Viewing old version and next is empty means current is next
             lines.append("next:")
-            lines.append("  - v0 (current)")
+            lines.append(f"  - @V{{0}}")
 
     lines.append("---")
     lines.append(item.summary)  # Summary IS the content
     return "\n".join(lines)
 
 
+def _format_summary_line(item: Item) -> str:
+    """Format item as single summary line: id@version date summary"""
+    # Get version-scoped ID
+    base_id = item.tags.get("_base_id", item.id)
+    version = item.tags.get("_version", "0")
+    versioned_id = f"{base_id}@V{{{version}}}"
+
+    # Get date (from _updated_date or _updated or _created)
+    date = item.tags.get("_updated_date") or item.tags.get("_updated", "")[:10] or item.tags.get("_created", "")[:10] or ""
+
+    # Truncate summary to ~60 chars, collapse newlines
+    summary = item.summary.replace("\n", " ")
+    if len(summary) > 60:
+        summary = summary[:57].rsplit(" ", 1)[0] + "..."
+
+    return f"{versioned_id} {date} {summary}"
+
+
+def _format_versioned_id(item: Item) -> str:
+    """Format item ID with version suffix: id@V{N}"""
+    base_id = item.tags.get("_base_id", item.id)
+    version = item.tags.get("_version", "0")
+    return f"{base_id}@V{{{version}}}"
+
+
 @app.callback(invoke_without_command=True)
 def main_callback(
     ctx: typer.Context,
@@ -188,11 +240,13 @@ def main_callback(
         item = kp.get_now()
         version_nav = kp.get_version_nav(NOWDOC_ID, None, collection="default")
         similar_items = kp.get_similar_for_display(NOWDOC_ID, limit=3, collection="default")
+        similar_offsets = {s.id: kp.get_version_offset(s) for s in similar_items}
         typer.echo(_format_item(
             item,
             as_json=_get_json_output(),
             version_nav=version_nav,
             similar_items=similar_items,
+            similar_offsets=similar_offsets,
         ))
 
 
@@ -235,38 +289,39 @@ SinceOption = Annotated[
 ]
 
 
-# -----------------------------------------------------------------------------
-# Output Helpers
-# -----------------------------------------------------------------------------
-
 def _format_item(
     item: Item,
     as_json: bool = False,
     version_nav: Optional[dict[str, list[VersionInfo]]] = None,
     viewing_offset: Optional[int] = None,
     similar_items: Optional[list[Item]] = None,
+    similar_offsets: Optional[dict[str, int]] = None,
 ) -> str:
     """
-    Format an item for display.
+    Format a single item for display.
 
-    Text format: YAML frontmatter (matches docs/system format)
-    With --ids: just the ID (for piping)
+    Output selection:
+      --ids: versioned ID only
+      --full or version_nav/similar_items present: YAML frontmatter
+      default: summary line (id@V{N} date summary)
 
     Args:
         item: The item to format
         as_json: Output as JSON
-        version_nav: Optional version navigation info (prev/next lists)
-        viewing_offset: If viewing an old version, the offset (1=previous, 2=two ago)
-        similar_items: Optional list of similar items to display
+        version_nav: Version navigation info (triggers full format)
+        viewing_offset: Version offset if viewing old version (triggers full format)
+        similar_items: Similar items to display (triggers full format)
+        similar_offsets: Version offsets for similar items
     """
     if _get_ids_output():
-        return json.dumps(item.id) if as_json else item.id
+        versioned_id = _format_versioned_id(item)
+        return json.dumps(versioned_id) if as_json else versioned_id
 
     if as_json:
         result = {
             "id": item.id,
             "summary": item.summary,
-            "tags": item.tags,
+            "tags": _filter_display_tags(item.tags),
             "score": item.score,
         }
         if viewing_offset is not None:
@@ -274,7 +329,12 @@ def _format_item(
             result["vid"] = f"{item.id}@V{{{viewing_offset}}}"
         if similar_items:
             result["similar"] = [
-                {"id": s.id, "score": s.score, "summary": s.summary[:60]}
+                {
+                    "id": f"{s.tags.get('_base_id', s.id)}@V{{{(similar_offsets or {}).get(s.id, 0)}}}",
+                    "score": s.score,
+                    "date": s.tags.get("_updated", s.tags.get("_created", ""))[:10],
+                    "summary": s.summary[:60],
+                }
                 for s in similar_items
             ]
         if version_nav:
@@ -304,13 +364,18 @@ def _format_item(
                 result["version_nav"]["next"] = [{"offset": 0, "vid": f"{item.id}@V{{0}}", "label": "current"}]
         return json.dumps(result)
 
-    return _format_yaml_frontmatter(item, version_nav, viewing_offset, similar_items)
+    # Full format when:
+    # - --full flag is set
+    # - version navigation or similar items are provided (can't display in summary)
+    if _get_full_output() or version_nav or similar_items or viewing_offset is not None:
+        return _format_yaml_frontmatter(item, version_nav, viewing_offset, similar_items, similar_offsets)
+    return _format_summary_line(item)
 
 
 def _format_items(items: list[Item], as_json: bool = False) -> str:
     """Format multiple items for display."""
     if _get_ids_output():
-        ids = [item.id for item in items]
+        ids = [_format_versioned_id(item) for item in items]
         return json.dumps(ids) if as_json else "\n".join(ids)
 
     if as_json:
@@ -318,15 +383,20 @@ def _format_items(items: list[Item], as_json: bool = False) -> str:
             {
                 "id": item.id,
                 "summary": item.summary,
-                "tags": item.tags,
+                "tags": _filter_display_tags(item.tags),
                 "score": item.score,
             }
             for item in items
         ], indent=2)
-    else:
-        if not items:
-            return "No results."
-        return "\n\n".join(_format_item(item, as_json=False) for item in items)
+
+    if not items:
+        return "No results."
+
+    # Full format: YAML frontmatter with double-newline separator
+    # Default: summary lines with single-newline separator
+    if _get_full_output():
+        return "\n\n".join(_format_yaml_frontmatter(item) for item in items)
+    return "\n".join(_format_summary_line(item) for item in items)
 
 
 def _get_keeper(store: Optional[Path], collection: str) -> Keeper:
@@ -417,7 +487,7 @@ def find(
 
 @app.command()
 def search(
-    query: Annotated[str, typer.Argument(help="Full-text search query")],
+    query: Annotated[str, typer.Argument(default=..., help="Full-text search query")],
     store: StoreOption = None,
     collection: CollectionOption = "default",
     limit: LimitOption = 10,
@@ -443,22 +513,11 @@ def list_recent(
     """
     List recent items by update time.
 
-    Shows IDs by default (composable). Use --full for detailed output.
+    Default: summary lines. Use --ids for IDs only, --full for YAML.
     """
     kp = _get_keeper(store, collection)
     results = kp.list_recent(limit=limit)
-
-    # Determine output mode: --full > --ids > command default (IDs for list)
-    if _get_json_output():
-        # JSON always outputs full items
-        typer.echo(_format_items(results, as_json=True))
-    elif _get_full_output():
-        # --full flag: full YAML output
-        typer.echo(_format_items(results, as_json=False))
-    else:
-        # Default for list: IDs only (composable)
-        for item in results:
-            typer.echo(item.id)
+    typer.echo(_format_items(results, as_json=_get_json_output()))
 
 
 @app.command()
@@ -519,7 +578,7 @@ def tag(
 
 @app.command("tag-update")
 def tag_update(
-    ids: Annotated[list[str], typer.Argument(help="Document IDs to tag")],
+    ids: Annotated[list[str], typer.Argument(default=..., help="Document IDs to tag")],
     tags: Annotated[Optional[list[str]], typer.Option(
         "--tag", "-t",
         help="Tag as key=value (empty value removes: key=)"
@@ -629,7 +688,7 @@ def update(
         # Use content-addressed ID for stdin text (enables versioning)
         doc_id = id or _text_content_id(content)
         item = kp.remember(content, id=doc_id, summary=summary, tags=parsed_tags or None, lazy=lazy)
-    elif source and "://" in source:
+    elif source and _URI_SCHEME_PATTERN.match(source):
         # URI mode: fetch from URI (ID is the URI itself)
         item = kp.update(source, tags=parsed_tags or None, summary=summary, lazy=lazy)
     elif source:
@@ -807,17 +866,19 @@ def now(
         item = kp.get_now()
         version_nav = kp.get_version_nav(NOWDOC_ID, None, collection=collection)
         similar_items = kp.get_similar_for_display(NOWDOC_ID, limit=3, collection=collection)
+        similar_offsets = {s.id: kp.get_version_offset(s) for s in similar_items}
         typer.echo(_format_item(
             item,
             as_json=_get_json_output(),
             version_nav=version_nav,
             similar_items=similar_items,
+            similar_offsets=similar_offsets,
         ))
 
 
 @app.command()
 def get(
-    id: Annotated[str, typer.Argument(help="URI of item (append @V{N} for version)")],
+    id: Annotated[str, typer.Argument(default=..., help="URI of item (append @V{N} for version)")],
     version: Annotated[Optional[int], typer.Option(
         "--version", "-V",
         help="Get specific version (0=current, 1=previous, etc.)"
@@ -927,18 +988,22 @@ def get(
     if similar:
         # List similar items
         similar_items = kp.get_similar_for_display(actual_id, limit=limit, collection=collection)
+        similar_offsets = {s.id: kp.get_version_offset(s) for s in similar_items}
 
         if _get_ids_output():
-            # Output IDs one per line
+            # Output version-scoped IDs one per line
             for item in similar_items:
-                typer.echo(item.id)
+                base_id = item.tags.get("_base_id", item.id)
+                offset = similar_offsets.get(item.id, 0)
+                typer.echo(f"{base_id}@V{{{offset}}}")
         elif _get_json_output():
             result = {
                 "id": actual_id,
                 "similar": [
                     {
-                        "id": item.id,
+                        "id": f"{item.tags.get('_base_id', item.id)}@V{{{similar_offsets.get(item.id, 0)}}}",
                         "score": item.score,
+                        "date": item.tags.get("_updated", item.tags.get("_created", ""))[:10],
                         "summary": item.summary[:60],
                     }
                     for item in similar_items
@@ -949,11 +1014,14 @@ def get(
             typer.echo(f"Similar to {actual_id}:")
             if similar_items:
                 for item in similar_items:
+                    base_id = item.tags.get("_base_id", item.id)
+                    offset = similar_offsets.get(item.id, 0)
                     score_str = f"({item.score:.2f})" if item.score else ""
+                    date_part = item.tags.get("_updated", item.tags.get("_created", ""))[:10]
                     summary_preview = item.summary[:50].replace("\n", " ")
                     if len(item.summary) > 50:
                         summary_preview += "..."
-                    typer.echo(f"  {item.id} {score_str} {summary_preview}")
+                    typer.echo(f"  {base_id}@V{{{offset}}} {score_str} {date_part} {summary_preview}")
             else:
                 typer.echo("  No similar items found.")
         return
@@ -985,8 +1053,10 @@ def get(
 
     # Get similar items (unless suppressed or viewing old version)
     similar_items = None
+    similar_offsets = None
     if not no_similar and offset == 0:
         similar_items = kp.get_similar_for_display(actual_id, limit=3, collection=collection)
+        similar_offsets = {s.id: kp.get_version_offset(s) for s in similar_items}
 
     typer.echo(_format_item(
         item,
@@ -994,6 +1064,7 @@ def get(
         version_nav=version_nav,
         viewing_offset=offset if offset > 0 else None,
         similar_items=similar_items,
+        similar_offsets=similar_offsets,
     ))
 
 
@@ -1019,6 +1090,10 @@ def list_collections(
 
 @app.command()
 def init(
+    reset_system_docs: Annotated[bool, typer.Option(
+        "--reset-system-docs",
+        help="Force reload system documents from bundled content (overwrites modifications)"
+    )] = False,
     store: StoreOption = None,
     collection: CollectionOption = "default",
 ):
@@ -1027,6 +1102,11 @@ def init(
     """
     kp = _get_keeper(store, collection)
 
+    # Handle reset if requested
+    if reset_system_docs:
+        stats = kp.reset_system_documents()
+        typer.echo(f"Reset {stats['reset']} system documents")
+
     # Show config and store paths
     config = kp._config
     config_path = config.config_path if config else None

keep/config.py

@@ -14,14 +14,12 @@ from pathlib import Path
 from typing import Any, Optional
 
 # tomli_w for writing TOML (tomllib is read-only)
-try:
-    import tomli_w
-except ImportError:
-    tomli_w = None  # type: ignore
+import tomli_w
 
 
 CONFIG_FILENAME = "keep.toml"
 CONFIG_VERSION = 3  # Bumped for document versioning support
+SYSTEM_DOCS_VERSION = 1  # Increment when bundled system docs content changes
 
 
 @dataclass
@@ -91,6 +89,9 @@ class StoreConfig:
     # Maximum length for summaries (used for smart remember and validation)
     max_summary_length: int = 500
 
+    # System docs version (tracks which bundled docs have been applied to this store)
+    system_docs_version: int = 0
+
     @property
     def config_path(self) -> Path:
         """Path to the TOML config file."""
@@ -354,6 +355,9 @@ def load_config(config_dir: Path) -> StoreConfig:
     # Parse max_summary_length (default 500)
     max_summary_length = data.get("store", {}).get("max_summary_length", 500)
 
+    # Parse system_docs_version (default 0 for stores that predate this feature)
+    system_docs_version = data.get("store", {}).get("system_docs_version", 0)
+
     return StoreConfig(
         path=actual_store,
         config_dir=config_dir,
@@ -366,6 +370,7 @@ def load_config(config_dir: Path) -> StoreConfig:
         embedding_identity=parse_embedding_identity(data.get("embedding_identity")),
         default_tags=default_tags,
         max_summary_length=max_summary_length,
+        system_docs_version=system_docs_version,
     )
 
 
@@ -387,9 +392,6 @@ def save_config(config: StoreConfig) -> None:
 
     Creates the directory if it doesn't exist.
     """
-    if tomli_w is None:
-        raise RuntimeError("tomli_w is required to save config. Install with: pip install tomli-w")
-
     # Ensure config directory exists
     config_location = config.config_dir if config.config_dir else config.path
     config_location.mkdir(parents=True, exist_ok=True)
@@ -410,6 +412,9 @@ def save_config(config: StoreConfig) -> None:
     # Only write max_summary_length if not default
     if config.max_summary_length != 500:
         store_section["max_summary_length"] = config.max_summary_length
+    # Write system_docs_version if set (tracks migration state)
+    if config.system_docs_version > 0:
+        store_section["system_docs_version"] = config.system_docs_version
 
     data = {
         "store": store_section,

keep/data/__init__.py

@@ -0,0 +1 @@
+# Package data for keep

keep/data/system/__init__.py

@@ -0,0 +1 @@
+# System documents for keep