kash-shell 0.3.28__tar.gz → 0.3.33__tar.gz

{kash_shell-0.3.28 → kash_shell-0.3.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kash-shell
-Version: 0.3.28
+Version: 0.3.33
 Summary: The knowledge agent shell (core)
 Project-URL: Repository, https://github.com/jlevy/kash-shell
 Author-email: Joshua Levy <joshua@cal.berkeley.edu>
@@ -20,7 +20,7 @@ Requires-Dist: aiolimiter>=1.2.1
 Requires-Dist: anyio>=4.8.0
 Requires-Dist: audioop-lts>=0.2.1; python_version >= '3.13'
 Requires-Dist: cachetools>=5.5.2
-Requires-Dist: chopdiff>=0.2.3
+Requires-Dist: chopdiff>=0.2.5
 Requires-Dist: clideps>=0.1.4
 Requires-Dist: colour>=0.1.5
 Requires-Dist: cssselect>=1.2.0
@@ -28,8 +28,8 @@ Requires-Dist: curl-cffi>=0.11.4
 Requires-Dist: deepgram-sdk>=3.10.1
 Requires-Dist: dunamai>=1.23.0
 Requires-Dist: fastapi>=0.115.11
-Requires-Dist: flowmark>=0.5.2
-Requires-Dist: frontmatter-format>=0.2.2
+Requires-Dist: flowmark>=0.5.3
+Requires-Dist: frontmatter-format>=0.2.3
 Requires-Dist: funlog>=0.2.0
 Requires-Dist: httpx[brotli]>=0.28.1
 Requires-Dist: humanfriendly>=10.0
@@ -46,7 +46,7 @@ Requires-Dist: pandas>=2.2.3
 Requires-Dist: patch-ng>=1.18.1
 Requires-Dist: pathspec>=0.12.1
 Requires-Dist: pluralizer>=1.2.0
-Requires-Dist: prettyfmt>=0.3.1
+Requires-Dist: prettyfmt>=0.4.1
 Requires-Dist: prompt-toolkit>=3.0.50
 Requires-Dist: pydantic>=2.10.6
 Requires-Dist: pydub>=0.25.1
@@ -62,9 +62,10 @@ Requires-Dist: regex>=2024.11.6
 Requires-Dist: rich-argparse>=1.7.0
 Requires-Dist: rich>=14.0.0
 Requires-Dist: ripgrepy>=2.1.0
+Requires-Dist: selectolax>=0.3.32
 Requires-Dist: send2trash>=1.8.3
 Requires-Dist: setproctitle>=1.3.5
-Requires-Dist: sidematter-format>=0.0.1
+Requires-Dist: sidematter-format>=0.0.5
 Requires-Dist: strif>=3.0.1
 Requires-Dist: tenacity>=9.0.0
 Requires-Dist: thefuzz>=0.22.1
@@ -85,6 +86,19 @@ src="https://github.com/user-attachments/assets/a5d62ae4-17e6-46bb-a9cb-3b6ec8d8
 
 </div>
 
+## Hello!
+
+If you’re seeing this, you there’s a good chance I shared it with you for feedback.
+Thank you for checking out Kash.
+
+It’s new, the result of some experimentation over the past few months.
+I like a lot of things about it but it isn’t mature and I’d love your help to make it
+more usable. If you try it please **let me know** what works and what doesn’t work.
+Or if you just don’t get it, where you lost interest or got stuck.
+My contact info is at [github.com/jlevy](https://github.com/jlevy) or [follow or DM
+me](https://x.com/ojoshe) (I’m fastest on Twitter DMs).
+Thank you. :)
+
 ## What is Kash?
 
 > “*Simple should be simple.
@@ -99,9 +113,15 @@ It operates on “items” such as URLs, files, or Markdown notes within a works
 directory.
 
 You can use Kash as an **interactive, AI-native command-line** shell for practical
-knowledge tasks. It’s also **a Python library** that lets you convert a simple Python
-function into a command and an MCP tool, so it integrates with other tools like
-Anthropic Desktop or Cursor.
+knowledge tasks.
+
+But it’s actually not just a shell, and you can skip the shell entirely.
+It’s really simply **a Python library** that lets you convert a simple Python function
+into “actions” that work in a clean way on plain files in a workspace.
+An action is also an MCP tool, so it integrates with other tools like Anthropic Desktop
+or Cursor.
+
+So basically, it gives a unified way to use the shell, Python functions, and MCP tools.
 
 It’s new and still has some rough edges, but it’s now working well enough it is feeling
 quite powerful. It now serves as a replacement for my usual shell (previously bash or
@@ -160,10 +180,10 @@ quick to install via uv.
 - **Support for any API:** Kash is tool agnostic and runs locally, on file inputs in
   simple formats, so you own and manage your data and workspaces however you like.
   You can use it with any models or APIs you like, and is already set up to use the APIs
-  of **OpenAI GPT-4o and o1**, **Anthropic Claude 3.7**, **Google Gemini**, **xAI
-  Grok**, **Mistral**, **Groq (Llama, Qwen, Deepseek)** (via **LiteLLM**), **Deepgram**,
-  **Perplexity**, **Firecrawl**, **Exa**, and any Python libraries.
-  There is also some experimental support for **LlamaIndex** and **ChromaDB**.
+  of **OpenAI** (GPT-5 is now the default model), **Anthropic Claude**, **Google
+  Gemini**, **xAI Grok**, **Mistral**, **Groq (Llama, Qwen, Deepseek)** (via
+  **LiteLLM**), **Deepgram**, **Perplexity**, **Firecrawl**, **Exa**, and any Python
+  libraries. There is also some experimental support for **LlamaIndex** and **ChromaDB**.
 
 - **MCP support:** Finally, an action is also an **MCP tool server** so you can use it
   in any MCP client, like Anthropic Desktop or Cursor.
@@ -198,17 +218,6 @@ I’ve separately built a new desktop terminal app, Kerm, which adds support for
 the terminal. Because Kash supports these codes, as this develops you will get the
 visuals of a web app layered on the flexibility of a text-based terminal.
 
-### Is Kash Mature?
-
-It’s the result of a couple months of coding and experimentation, and it’s still in
-progress and has rough edges.
-Please help me make it better by sharing your ideas and feedback!
-It’s easiest to DM me at [twitter.com/ojoshe](https://x.com/ojoshe).
-My contact info is at [github.com/jlevy](https://github.com/jlevy).
-
-[**Please follow or DM me**](https://x.com/ojoshe) for future updates or if you have
-ideas, feedback, or use cases for Kash!
-
 ## Installation
 
 ### Running the Kash Shell
@@ -271,8 +280,8 @@ These are for `kash-media` but you can use a `kash-shell` for a more basic setup
 
    ```shell
    sudo apt-get update
-   sudo apt-get install -y libgl1 ffmpeg libmagic-dev 
-   # For the additional command-line tools, pixi is better on Ubuntu:
+   sudo apt-get install -y libgl1 ffmpeg libmagic-dev imagemagick bat ripgrep hexyl
+   # Or for more additional command-line tools, pixi is better on Ubuntu:
    curl -fsSL https://pixi.sh/install.sh | sh
    . ~/.bashrc
    pixi global install ripgrep bat eza hexyl imagemagick zoxide

{kash_shell-0.3.28 → kash_shell-0.3.33}/README.md

@@ -7,6 +7,19 @@ src="https://github.com/user-attachments/assets/a5d62ae4-17e6-46bb-a9cb-3b6ec8d8
 
 </div>
 
+## Hello!
+
+If you’re seeing this, you there’s a good chance I shared it with you for feedback.
+Thank you for checking out Kash.
+
+It’s new, the result of some experimentation over the past few months.
+I like a lot of things about it but it isn’t mature and I’d love your help to make it
+more usable. If you try it please **let me know** what works and what doesn’t work.
+Or if you just don’t get it, where you lost interest or got stuck.
+My contact info is at [github.com/jlevy](https://github.com/jlevy) or [follow or DM
+me](https://x.com/ojoshe) (I’m fastest on Twitter DMs).
+Thank you. :)
+
 ## What is Kash?
 
 > “*Simple should be simple.
@@ -21,9 +34,15 @@ It operates on “items” such as URLs, files, or Markdown notes within a works
 directory.
 
 You can use Kash as an **interactive, AI-native command-line** shell for practical
-knowledge tasks. It’s also **a Python library** that lets you convert a simple Python
-function into a command and an MCP tool, so it integrates with other tools like
-Anthropic Desktop or Cursor.
+knowledge tasks.
+
+But it’s actually not just a shell, and you can skip the shell entirely.
+It’s really simply **a Python library** that lets you convert a simple Python function
+into “actions” that work in a clean way on plain files in a workspace.
+An action is also an MCP tool, so it integrates with other tools like Anthropic Desktop
+or Cursor.
+
+So basically, it gives a unified way to use the shell, Python functions, and MCP tools.
 
 It’s new and still has some rough edges, but it’s now working well enough it is feeling
 quite powerful. It now serves as a replacement for my usual shell (previously bash or
@@ -82,10 +101,10 @@ quick to install via uv.
 - **Support for any API:** Kash is tool agnostic and runs locally, on file inputs in
   simple formats, so you own and manage your data and workspaces however you like.
   You can use it with any models or APIs you like, and is already set up to use the APIs
-  of **OpenAI GPT-4o and o1**, **Anthropic Claude 3.7**, **Google Gemini**, **xAI
-  Grok**, **Mistral**, **Groq (Llama, Qwen, Deepseek)** (via **LiteLLM**), **Deepgram**,
-  **Perplexity**, **Firecrawl**, **Exa**, and any Python libraries.
-  There is also some experimental support for **LlamaIndex** and **ChromaDB**.
+  of **OpenAI** (GPT-5 is now the default model), **Anthropic Claude**, **Google
+  Gemini**, **xAI Grok**, **Mistral**, **Groq (Llama, Qwen, Deepseek)** (via
+  **LiteLLM**), **Deepgram**, **Perplexity**, **Firecrawl**, **Exa**, and any Python
+  libraries. There is also some experimental support for **LlamaIndex** and **ChromaDB**.
 
 - **MCP support:** Finally, an action is also an **MCP tool server** so you can use it
   in any MCP client, like Anthropic Desktop or Cursor.
@@ -120,17 +139,6 @@ I’ve separately built a new desktop terminal app, Kerm, which adds support for
 the terminal. Because Kash supports these codes, as this develops you will get the
 visuals of a web app layered on the flexibility of a text-based terminal.
 
-### Is Kash Mature?
-
-It’s the result of a couple months of coding and experimentation, and it’s still in
-progress and has rough edges.
-Please help me make it better by sharing your ideas and feedback!
-It’s easiest to DM me at [twitter.com/ojoshe](https://x.com/ojoshe).
-My contact info is at [github.com/jlevy](https://github.com/jlevy).
-
-[**Please follow or DM me**](https://x.com/ojoshe) for future updates or if you have
-ideas, feedback, or use cases for Kash!
-
 ## Installation
 
 ### Running the Kash Shell
@@ -193,8 +201,8 @@ These are for `kash-media` but you can use a `kash-shell` for a more basic setup
 
    ```shell
    sudo apt-get update
-   sudo apt-get install -y libgl1 ffmpeg libmagic-dev 
-   # For the additional command-line tools, pixi is better on Ubuntu:
+   sudo apt-get install -y libgl1 ffmpeg libmagic-dev imagemagick bat ripgrep hexyl
+   # Or for more additional command-line tools, pixi is better on Ubuntu:
    curl -fsSL https://pixi.sh/install.sh | sh
    . ~/.bashrc
    pixi global install ripgrep bat eza hexyl imagemagick zoxide

{kash_shell-0.3.28 → kash_shell-0.3.33}/pyproject.toml

@@ -44,11 +44,11 @@ dependencies = [
     # My tools:
     "strif>=3.0.1",
     "funlog>=0.2.0",
-    "prettyfmt>=0.3.1",
-    "flowmark>=0.5.2",
-    "frontmatter-format>=0.2.2",
-    "sidematter-format>=0.0.1",
-    "chopdiff>=0.2.3",
+    "prettyfmt>=0.4.1",
+    "flowmark>=0.5.3",
+    "frontmatter-format>=0.2.3",
+    "sidematter-format>=0.0.5",
+    "chopdiff>=0.2.5",
     "clideps>=0.1.4",
     "tminify>=0.1.6",
     # Shell and file essentials:
@@ -89,6 +89,7 @@ dependencies = [
     "pyrate-limiter>=3.7.0",
     "aiolimiter>=1.2.1",
     # Basic text handling and web scraping:
+    "selectolax>=0.3.32",
     "readabilipy>=0.3.0",
     "markdownify>=0.13.1",
     "justext>=3.0.2",
@@ -130,7 +131,10 @@ kash-mcp = "kash.mcp.mcp_cli:main"
 [tool.uv.sources]
 # For local development:
 # clideps = { path = "../clideps", editable = true }
-# tminify = { path = "../../github/tminify", editable = true }
+# tminify = { path = "../tminify", editable = true }
+# chopdiff = { path = "../chopdiff", editable = true }
+# sidematter-format = { path = "../sidematter-format", editable = true }
+# frontmatter-format = { path = "../frontmatter-format", editable = true }
 
 # ---- Build system ----
 
@@ -150,7 +154,7 @@ source = "uv-dynamic-versioning"
 [tool.uv-dynamic-versioning]
 vcs = "git"
 style = "pep440"
-bump = "true"
+bump = true
 
 # Explicitly configure top-level namespace for hatch.
 [tool.hatch.build.targets.wheel]

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/chat.py

@@ -28,6 +28,7 @@ log = get_logger(__name__)
 @kash_action(
     expected_args=ONE_OR_NO_ARGS,
     precondition=is_chat,
+    output_format=Format.yaml,
     uses_selection=False,
     interactive_input=True,
     cacheable=False,

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/markdownify_html.py

@@ -5,7 +5,6 @@ from kash.exec import kash_action
 from kash.exec.preconditions import has_html_body, is_url_resource
 from kash.exec.runtime_settings import current_runtime_settings
 from kash.model import Format, Item
-from kash.model.items_model import ItemType
 from kash.utils.text_handling.markdown_utils import first_heading
 from kash.utils.text_handling.markdownify_utils import markdownify_custom
 from kash.web_content.file_cache_utils import get_url_html
@@ -14,7 +13,9 @@ from kash.web_content.web_extract_readabilipy import extract_text_readabilipy
 log = get_logger(__name__)
 
 
-@kash_action(precondition=is_url_resource | has_html_body, mcp_tool=True)
+@kash_action(
+    precondition=is_url_resource | has_html_body, output_format=Format.markdown, mcp_tool=True
+)
 def markdownify_html(item: Item) -> Item:
     """
     Converts raw HTML or the URL of an HTML page to Markdown, fetching with the content
@@ -36,7 +37,5 @@ def markdownify_html(item: Item) -> Item:
         # Insert a h1 at the top of the document
         markdown_content = f"# {title}\n\n{markdown_content}"
 
-    output_item = item.derived_copy(
-        type=ItemType.doc, format=Format.markdown, body=markdown_content
-    )
+    output_item = item.derived_copy(format=Format.markdown, body=markdown_content)
     return output_item

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/minify_html.py

@@ -14,13 +14,12 @@ from kash.workspaces.workspaces import current_ws
 )
 def minify_html(item: Item) -> Item:
     """
-    Minify an HTML item's content using [html-minifier-terser](https://github.com/terser/html-minifier-terser).
-
+    Minify an HTML item's content using [tminify](https://github.com/jlevy/tminify).
     Also supports Tailwind CSS v4 compilation and inlining, if any Tailwind
     CSS v4 CDN script tags are found.
 
-    The terser minification seems a bit slower but more robust than
-    [minify-html](https://github.com/wilsonzlin/minify-html).
+    Tminify uses [html-minifier-terser](https://github.com/terser/html-minifier-terser).
+    This is a bit slower but more robust than [minify-html](https://github.com/wilsonzlin/minify-html).
     """
     from tminify.main import tminify
 
@@ -31,7 +30,7 @@ def minify_html(item: Item) -> Item:
     input_path = ws.base_dir / item.store_path
 
     output_item = item.derived_copy(format=Format.html, body=None)
-    output_path = ws.target_path_for(output_item)
+    output_path = ws.assign_store_path(output_item)
 
     tminify(input_path, output_path)
 

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/readability.py

@@ -9,10 +9,7 @@ from kash.web_content.web_extract_readabilipy import extract_text_readabilipy
 log = get_logger(__name__)
 
 
-@kash_action(
-    precondition=is_url_resource | has_html_body,
-    mcp_tool=True,
-)
+@kash_action(precondition=is_url_resource | has_html_body, output_format=Format.html)
 def readability(item: Item) -> Item:
     """
     Extracts clean HTML from a raw HTML item.

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/render_as_html.py

@@ -1,17 +1,21 @@
 from kash.actions.core.tabbed_webpage_config import tabbed_webpage_config
 from kash.actions.core.tabbed_webpage_generate import tabbed_webpage_generate
+from kash.config.logger import get_logger
 from kash.exec import kash_action
 from kash.exec.preconditions import has_fullpage_html_body, has_html_body, has_simple_text_body
 from kash.exec_model.args_model import ONE_OR_MORE_ARGS
 from kash.model import ActionInput, ActionResult, Param
 from kash.model.items_model import ItemType
 from kash.utils.file_utils.file_formats_model import Format
-from kash.web_gen.simple_webpage import simple_webpage_render
+from kash.web_gen.webpage_render import render_item_as_html
+
+log = get_logger(__name__)
 
 
 @kash_action(
     expected_args=ONE_OR_MORE_ARGS,
     precondition=(has_html_body | has_simple_text_body) & ~has_fullpage_html_body,
+    output_format=Format.html,
     params=(Param("no_title", "Don't add a title to the page body.", type=bool),),
 )
 def render_as_html(input: ActionInput, no_title: bool = False) -> ActionResult:
@@ -27,12 +31,11 @@ def render_as_html(input: ActionInput, no_title: bool = False) -> ActionResult:
     """
     if len(input.items) == 1:
         input_item = input.items[0]
-        html_body = simple_webpage_render(
-            input_item, add_title_h1=not no_title, show_theme_toggle=True
-        )
-        result_item = input_item.derived_copy(
-            type=ItemType.export, format=Format.html, body=html_body
-        )
+
+        result_item = input_item.derived_copy(type=ItemType.export, format=Format.html)
+
+        result_item = render_item_as_html(input_item, result_item, add_title_h1=not no_title)
+
         return ActionResult([result_item])
     else:
         config_result = tabbed_webpage_config(input)

kash_shell-0.3.33/src/kash/actions/core/save_sidematter_meta.py

@@ -0,0 +1,47 @@
+from prettyfmt import fmt_lines
+from sidematter_format import Sidematter
+
+from kash.config.logger import get_logger
+from kash.exec import kash_action
+from kash.exec_model.args_model import ONE_OR_MORE_ARGS
+from kash.model.actions_model import ActionInput, ActionResult
+from kash.workspaces.workspaces import current_ws
+
+log = get_logger(__name__)
+
+
+@kash_action(expected_args=ONE_OR_MORE_ARGS)
+def save_sidematter_meta(input: ActionInput) -> ActionResult:
+    """
+    Write the item's metadata as a [sidematter format](https://github.com/jlevy/sidematter-format)
+    as `.meta.yml` and `.meta.json` files.
+
+    If additional data items are provided, their data is merged into the primary item's metadata.
+    This is useful for link data etc.
+    """
+    items = input.items
+    assert items
+
+    primary = items[0]
+    assert primary.store_path
+
+    ws = current_ws()
+    sm = Sidematter(ws.base_dir / primary.store_path)
+
+    metadata_dict = primary.metadata()
+
+    for item in items[1:]:
+        assert item.store_path
+        metadata_dict = metadata_dict | item.read_as_data()
+
+    # Write both JSON and YAML sidematter metadata
+    sm.write_meta(metadata_dict, formats="all", make_parents=True)
+
+    log.message(
+        "Wrote sidematter metadata:\n%s",
+        fmt_lines(
+            [sm.meta_json_path.relative_to(ws.base_dir), sm.meta_yaml_path.relative_to(ws.base_dir)]
+        ),
+    )
+
+    return ActionResult(items=[primary])

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/actions/core/show_webpage.py

@@ -6,11 +6,13 @@ from kash.exec_model.args_model import ONE_OR_MORE_ARGS
 from kash.exec_model.commands_model import Command
 from kash.exec_model.shell_model import ShellResult
 from kash.model import ActionInput, ActionResult
+from kash.utils.file_utils.file_formats_model import Format
 
 
 @kash_action(
     expected_args=ONE_OR_MORE_ARGS,
     precondition=(has_html_body | has_simple_text_body) & ~has_fullpage_html_body,
+    output_format=Format.html,
 )
 def show_webpage(input: ActionInput) -> ActionResult:
     """

kash_shell-0.3.33/src/kash/actions/core/zip_sidematter.py

@@ -0,0 +1,47 @@
+import zipfile
+
+from sidematter_format import Sidematter
+
+from kash.config.logger import get_logger
+from kash.exec import kash_action
+from kash.model.items_model import Item, ItemType
+from kash.utils.file_utils.file_formats_model import Format
+from kash.workspaces.workspaces import current_ws
+
+log = get_logger(__name__)
+
+
+@kash_action()
+def zip_sidematter(item: Item) -> Item:
+    """
+    Zip all contents of the item, its sidematter metadata and items.
+    """
+    assert item.store_path
+    ws = current_ws()
+    sm = Sidematter(ws.base_dir / item.store_path)
+
+    base_dir = sm.primary.parent
+
+    # Collect all files to include; store paths relative to the primary's directory
+    files_to_zip: list[tuple] = []
+
+    files_to_zip.append((sm.primary, sm.primary.relative_to(base_dir)))
+    if sm.meta_json_path.exists():
+        files_to_zip.append((sm.meta_json_path, sm.meta_json_path.relative_to(base_dir)))
+    if sm.meta_yaml_path.exists():
+        files_to_zip.append((sm.meta_yaml_path, sm.meta_yaml_path.relative_to(base_dir)))
+    if sm.assets_dir.exists():
+        for p in sm.assets_dir.rglob("*"):
+            if p.is_file():
+                files_to_zip.append((p, p.relative_to(base_dir)))
+
+    output_item = item.derived_copy(type=ItemType.export, format=Format.zip)
+    target = ws.assign_store_path(output_item)
+
+    with zipfile.ZipFile(
+        target, mode="w", compression=zipfile.ZIP_DEFLATED, compresslevel=9
+    ) as zipf:
+        for path, arcname in files_to_zip:
+            zipf.write(path, arcname)
+
+    return output_item

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/commands/base/basic_file_commands.py

@@ -33,7 +33,8 @@ def clipboard_copy(path: str | None = None, raw: bool = False) -> None:
     Copy the contents of a file (or the first file in the selection) to the OS-native
     clipboard. Similar to `pbcopy` on macOS.
 
-    :param raw: Copy the full exact contents of the file. Otherwise frontmatter is omitted.
+    Args:
+        raw: Copy the full exact contents of the file. Otherwise frontmatter is omitted.
     """
     # TODO: Get this to work for images!
     import pyperclip
@@ -95,7 +96,8 @@ def edit(path: str | None = None, all: bool = False) -> None:
     """
     Edit the contents of a file using the user's default editor (or defaulting to nano).
 
-    :param all: Normally edits only the first file given. This passes all files to the editor.
+    Args:
+        all: Normally edits only the first file given. This passes all files to the editor.
     """
     input_paths = assemble_path_args(path)
     if not all:
@@ -111,8 +113,9 @@ def file_info(*paths: str, size_summary: bool = False, format: bool = False) ->
     structure of the items at the given paths (for text documents) and the detected
     mime type.
 
-    :param size_summary: Only show size summary (words, sentences, paragraphs for a text document).
-    :param format: Only show detected file format.
+    Args:
+        size_summary: Only show size summary (words, sentences, paragraphs for a text document).
+        format: Only show detected file format.
     """
     if not size_summary and not format:
         size_summary = format = True

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/commands/base/diff_commands.py

@@ -57,8 +57,9 @@ def diff_items(*paths: str, force: bool = False) -> ShellResult:
     as items themselves, so this works on items. Items are imported as usual into the
     global workspace if they are not already in the store.
 
-    :param stat: Only show the diffstat summary.
-    :param force: If true, will run the diff even if the items are of different formats.
+    Args:
+        stat: Only show the diffstat summary.
+        force: If true, will run the diff even if the items are of different formats.
     """
     ws = current_ws()
     if len(paths) == 2:
@@ -90,8 +91,9 @@ def diff_files(*paths: str, diffstat: bool = False, save: bool = False) -> Shell
     Show the unified diff between the given files. This works on any files, not
     just items, so helpful for quick analysis without importing the files.
 
-    :param diffstat: Only show the diffstat summary.
-    :param save: Save the diff as an item in the store.
+    Args:
+        diffstat: Only show the diffstat summary.
+        save: Save the diff as an item in the store.
     """
     if len(paths) == 2:
         [path1, path2] = paths

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/commands/base/files_command.py

@@ -111,36 +111,37 @@ def files(
     with limited depth and breadth, and more control over recursion, sorting,
     and grouping.
 
-    :param overview: Recurse a couple levels and show files, but not too many.
-        Same as `--groupby=parent --depth=2 --max_per_group=100 --omit_dirs`
-        except also scales down `max_per_group` to 25 or 50 if there are many files.
-    :param recent: Only shows the most recently modified files in each directory.
-        Same as `--sort=modified --reverse --groupby=parent --max_per_group=100`
-        except also scales down `max_per_group` to 25 or 50 if there are many files.
-    :param recursive: List all files recursively. Same as `--depth=-1`.
-    :param flat: Show files in a flat list, rather than grouped by parent directory.
-        Same as `--groupby=flat`.
-    :param omit_dirs: Normally directories are included. This option omits them,
-        which is useful when recursing into subdirectories.
-    :param depth: Maximum depth to recurse into directories. -1 means no limit.
-    :param max_files: Maximum number of files to yield per input path.
-        -1 means no limit.
-    :param max_per_subdir: Maximum number of files to yield per subdirectory
-        (not including the top level). -1 means no limit.
-    :param max_per_group: Limit the first number of items displayed per group
-        (if groupby is used) or in total. 0 means show all.
-    :param no_max: Disable limits on depth and number of files. Same as
-        `--depth=-1 --max_files=-1 --max_per_subdir=-1 --max_per_group=-1`.
-    :param no_ignore: Disable ignoring hidden files.
-    :param all: Same as `--no_ignore --no_max`. Does not change `--depth`.
-    :param save: Save the listing as a CSV file item.
-    :param sort: Sort by `filename`, `size`, `accessed`, `created`, or `modified`.
-    :param reverse: Reverse the sorting order.
-    :param since: Filter files modified since a given time (e.g., '1 day', '2 hours').
-    :param groupby: Group results. Can be `flat` (no grouping, and by default implies
-        recursive), `parent`, or `suffix`. Defaults to 'parent'.
-    :param iso_time: Show time in ISO format (default is human-readable age).
-    :param pager: Use the pager when displaying the output.
+    Args:
+        overview: Recurse a couple levels and show files, but not too many.
+            Same as `--groupby=parent --depth=2 --max_per_group=100 --omit_dirs`
+            except also scales down `max_per_group` to 25 or 50 if there are many files.
+        recent: Only shows the most recently modified files in each directory.
+            Same as `--sort=modified --reverse --groupby=parent --max_per_group=100`
+            except also scales down `max_per_group` to 25 or 50 if there are many files.
+        recursive: List all files recursively. Same as `--depth=-1`.
+        flat: Show files in a flat list, rather than grouped by parent directory.
+            Same as `--groupby=flat`.
+        omit_dirs: Normally directories are included. This option omits them,
+            which is useful when recursing into subdirectories.
+        depth: Maximum depth to recurse into directories. -1 means no limit.
+        max_files: Maximum number of files to yield per input path.
+            -1 means no limit.
+        max_per_subdir: Maximum number of files to yield per subdirectory
+            (not including the top level). -1 means no limit.
+        max_per_group: Limit the first number of items displayed per group
+            (if groupby is used) or in total. 0 means show all.
+        no_max: Disable limits on depth and number of files. Same as
+            `--depth=-1 --max_files=-1 --max_per_subdir=-1 --max_per_group=-1`.
+        no_ignore: Disable ignoring hidden files.
+        all: Same as `--no_ignore --no_max`. Does not change `--depth`.
+        save: Save the listing as a CSV file item.
+        sort: Sort by `filename`, `size`, `accessed`, `created`, or `modified`.
+        reverse: Reverse the sorting order.
+        since: Filter files modified since a given time (e.g., '1 day', '2 hours').
+        groupby: Group results. Can be `flat` (no grouping, and by default implies
+            recursive), `parent`, or `suffix`. Defaults to 'parent'.
+        iso_time: Show time in ISO format (default is human-readable age).
+        pager: Use the pager when displaying the output.
     """
     if global_settings().use_nerd_icons:
         from kash.shell.file_icons.nerd_icons import icon_for_file

{kash_shell-0.3.28 → kash_shell-0.3.33}/src/kash/commands/base/general_commands.py

@@ -160,8 +160,9 @@ def check_system_tools(warn_only: bool = False, brief: bool = False) -> None:
     """
     Check that all tools are installed.
 
-    :param warn_only: Only warn if tools are missing.
-    :param brief: Print summary as a single line.
+    Args:
+        warn_only: Only warn if tools are missing.
+        brief: Print summary as a single line.
     """
     if warn_only:
         pkg_check().warn_if_missing()