autosh 0.0.0__tar.gz → 0.0.1__tar.gz

autosh-0.0.1/.gitignore

@@ -0,0 +1,18 @@
+/target
+
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables
+.env
+
+# Other files
+/_*

{autosh-0.0.0 → autosh-0.0.1}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Arnaud Blois
+Copyright (c) 2024 Wenyu Zhao
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

autosh-0.0.1/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: autosh
+Version: 0.0.1
+Summary: Add your description here
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: agentia>=0.0.5
+Requires-Dist: asyncio>=3.4.3
+Requires-Dist: markdownify>=1.1.0
+Requires-Dist: pydantic>=2.11.3
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: rich>=14.0.0
+Requires-Dist: tavily-python>=0.5.4
+Requires-Dist: typer>=0.12.5
+Requires-Dist: tzlocal>=5.3.1
+Description-Content-Type: text/markdown
+
+# `autosh` - The AI-powered, noob-friendly interactive shell
+
+# Getting Started
+
+## Install
+
+```bash
+uv tool install autosh
+```
+
+## Usage
+
+As an interactive shell: `ash` (alternatively, `autosh`)
+
+Execute a single prompt: `ash "list current directory"`
+
+Process piped data: `cat README.md | ash "summarise"`
+
+## Scripting
+
+Write AI-powered shell scripts in Markdown using natural language!
+
+Example script ([simple.a.md](examples/simple.a.md)):
+
+```markdown
+#!/usr/bin/env ash
+
+# This is a simple file manipulation script
+
+First, please display a welcome message:)
+
+Write "Hello, world" to _test.log
+```
+
+* Run the script: `ash simple.a.md` or `chmod +x simple.a.md && simple.a.md`
+* Auto generate help messages:
+
+    ```console
+    $ ash simple.a.md -h
+
+    Usage: simple.a.md [OPTIONS]
+
+    This is a simple file manipulation script that writes "Hello, world" to a log file named _x.log.
+
+    Options:
+
+    • -h, --help     Show this message and exit.
+    ```
+
+## Plugins
+
+`autosh` is equipped with several plugins to expand its potential:
+
+* `ash "Create a directory "my-news", list the latest news, for each news, put the summary in a separate markdown file in this directory"`
+
+# TODO
+
+- [ ] Image generation
+- [ ] Image input
+- [ ] RAG for non-text files

autosh-0.0.1/README.md

@@ -0,0 +1,60 @@
+# `autosh` - The AI-powered, noob-friendly interactive shell
+
+# Getting Started
+
+## Install
+
+```bash
+uv tool install autosh
+```
+
+## Usage
+
+As an interactive shell: `ash` (alternatively, `autosh`)
+
+Execute a single prompt: `ash "list current directory"`
+
+Process piped data: `cat README.md | ash "summarise"`
+
+## Scripting
+
+Write AI-powered shell scripts in Markdown using natural language!
+
+Example script ([simple.a.md](examples/simple.a.md)):
+
+```markdown
+#!/usr/bin/env ash
+
+# This is a simple file manipulation script
+
+First, please display a welcome message:)
+
+Write "Hello, world" to _test.log
+```
+
+* Run the script: `ash simple.a.md` or `chmod +x simple.a.md && simple.a.md`
+* Auto generate help messages:
+
+    ```console
+    $ ash simple.a.md -h
+
+    Usage: simple.a.md [OPTIONS]
+
+    This is a simple file manipulation script that writes "Hello, world" to a log file named _x.log.
+
+    Options:
+
+    • -h, --help     Show this message and exit.
+    ```
+
+## Plugins
+
+`autosh` is equipped with several plugins to expand its potential:
+
+* `ash "Create a directory "my-news", list the latest news, for each news, put the summary in a separate markdown file in this directory"`
+
+# TODO
+
+- [ ] Image generation
+- [ ] Image input
+- [ ] RAG for non-text files

autosh-0.0.1/autosh/config.py

@@ -0,0 +1,78 @@
+import sys
+from pydantic import BaseModel, Field
+from pathlib import Path
+import tomllib
+
+USER_CONFIG_PATH = Path.home() / ".config" / "autosh" / "config.toml"
+
+
+class EmptyConfig(BaseModel): ...
+
+
+class SearchConfig(BaseModel):
+    tavily_api_key: str = Field(..., description="Tavily API key.")
+
+
+class WebConfig(BaseModel):
+    tavily_api_key: str = Field(..., description="Tavily API key.")
+
+
+class Plugins(BaseModel):
+    calc: EmptyConfig | None = None
+    cli: EmptyConfig | None = None
+    clock: EmptyConfig | None = None
+    code: EmptyConfig | None = None
+    search: SearchConfig | None = None
+    web: WebConfig | None = None
+
+
+class Config(BaseModel):
+    model: str = Field(default="openai/gpt-4.1", description="The LLM model to use")
+    think_model: str = Field(
+        default="openai/o4-mini-high",
+        description="The LLM model to use for reasoning before executing commands",
+    )
+    api_key: str | None = Field(default=None, description="OpenRouter API key.")
+
+    plugins: Plugins = Field(
+        default_factory=Plugins,
+        description="Plugin configuration. Set to null to disable the plugin.",
+    )
+
+    @staticmethod
+    def load() -> "Config":
+        if USER_CONFIG_PATH.is_file():
+            doc = tomllib.loads(USER_CONFIG_PATH.read_text())
+            main = doc.get("autosh", {})
+            plugins = Plugins(**doc.get("plugins", {}))
+            config = Config.model_validate({**main, "plugins": plugins})
+        else:
+            config = Config()
+        return config
+
+
+CONFIG = Config.load()
+
+
+class CLIOptions(BaseModel):
+    yes: bool = False
+    quiet: bool = False
+    think: bool = False
+
+    prompt: str | None = None
+    """The prompt to execute"""
+
+    script: Path | None = None
+    """The scripe providing the prompt"""
+
+    stdin_is_script: bool = False
+    """STDIN is a script, not a piped input."""
+
+    args: list[str] = Field(default_factory=list, description="Command line arguments")
+
+    def stdin_has_data(self) -> bool:
+        """Check if stdin has data."""
+        return not sys.stdin.isatty() and not CLI_OPTIONS.stdin_is_script
+
+
+CLI_OPTIONS = CLIOptions()

autosh-0.0.1/autosh/main.py

@@ -0,0 +1,164 @@
+import os
+from pathlib import Path
+import rich
+import typer
+import asyncio
+import dotenv
+from rich.columns import Columns
+from rich.panel import Panel
+import argparse
+
+from autosh.config import CLI_OPTIONS, CONFIG
+from .session import Session
+import sys
+
+
+app = typer.Typer(
+    no_args_is_help=False,
+    add_completion=False,
+    context_settings=dict(help_option_names=["-h", "--help"]),
+    pretty_exceptions_short=True,
+    pretty_exceptions_show_locals=False,
+    help="Autosh is a command line tool that helps you automate your tasks using LLMs.",
+)
+
+
+async def start_session(prompt: str | None, args: list[str]):
+    CLI_OPTIONS.args = args
+    session = Session()
+    await session.init()
+    piped_stdin = not sys.stdin.isatty()
+    if piped_stdin and not CLI_OPTIONS.yes:
+        rich.print(
+            "[bold red]Error:[/bold red] [red]--yes is required when using piped stdin.[/red]"
+        )
+        sys.exit(1)
+    if prompt:
+        # No piped stdin, just run the prompt
+        if Path(prompt).is_file():
+            # Prompt is a file, read it and execute it
+            await session.exec_script(Path(prompt))
+        else:
+            # Prompt is a string, execute it directly
+            await session.exec_prompt(prompt)
+    elif not prompt and not sys.stdin.isatty():
+        # Piped stdin without prompt, treat piped stdin as a prompt.
+        await session.exec_from_stdin()
+    else:
+        await session.run_repl()
+
+
+def print_help():
+    cmd = Path(sys.argv[0]).name
+    rich.print(
+        f"\n [bold yellow]Usage:[/bold yellow] [bold]{cmd} [OPTIONS] [--] [PROMPT_OR_FILE] [ARGS]...[/bold]\n"
+    )
+
+    args = [
+        ["prompt_or_file", "[PROMPT_OR_FILE]", "The prompt or file to execute."],
+        ["args", "[ARGS]...", "The arguments to pass to the script."],
+    ]
+    options = [
+        ["--yes", "-y", "Auto confirm all prompts."],
+        ["--quiet", "-q", "Suppress all output."],
+        [
+            "--model",
+            "-m",
+            f"The LLM model to use. [dim]Default: {CONFIG.model} ({CONFIG.think_model} for reasoning).[/dim]",
+        ],
+        ["--think", "", "Use the reasoning models to think more before operating."],
+        ["--help", "-h", "Show this message and exit."],
+    ]
+
+    rich.print(
+        Panel.fit(
+            Columns(
+                [
+                    "\n".join([a[0] for a in args]),
+                    "\n".join([f"[bold yellow]\\{a[1]}[/bold yellow]" for a in args]),
+                    "\n".join(["   " + a[2] for a in args]),
+                ],
+                padding=(0, 3),
+            ),
+            title="[dim]Arguments[/dim]",
+            title_align="left",
+            padding=(0, 3),
+        )
+    )
+
+    rich.print(
+        Panel.fit(
+            Columns(
+                [
+                    "\n".join([f"[bold blue]{o[0]}[/bold blue]" for o in options]),
+                    "\n".join([f"[bold green]{o[1]}[/bold green]" for o in options]),
+                    "\n".join(["    " + o[2] for o in options]),
+                ],
+                padding=(0, 2),
+            ),
+            title="[dim]Options[/dim]",
+            title_align="left",
+            padding=(0, 3),
+        )
+    )
+
+
+def parse_args() -> tuple[str | None, list[str]]:
+    p = argparse.ArgumentParser(add_help=False, exit_on_error=False)
+
+    p.add_argument("--help", "-h", action="store_true")
+    p.add_argument("--yes", "-y", action="store_true")
+    p.add_argument("--quiet", "-q", action="store_true")
+    p.add_argument("--think", action="store_true")
+    p.add_argument("--model", "-m", type=str, default=None)
+    p.add_argument("PROMPT_OR_FILE", nargs="?", default=None)
+    p.add_argument("ARGS", nargs=argparse.REMAINDER)
+
+    try:
+        args = p.parse_args()
+    except argparse.ArgumentError as e:
+        rich.print(f"[bold red]Error:[/bold red] {str(e)}")
+        print_help()
+        sys.exit(1)
+
+    if args.help:
+        print_help()
+        sys.exit(0)
+
+    CLI_OPTIONS.yes = args.yes
+    CLI_OPTIONS.quiet = args.quiet
+
+    if args.model:
+        if args.think:
+            CONFIG.think_model = args.model
+        else:
+            CONFIG.model = args.model
+
+    if args.think:
+        CLI_OPTIONS.think = True
+
+    prompt = args.PROMPT_OR_FILE.strip() if args.PROMPT_OR_FILE else None
+
+    if prompt == "":
+        prompt = None
+
+    return prompt, (args.ARGS or [])
+
+
+def main():
+    # dotenv.load_dotenv()
+    prompt, args = parse_args()
+
+    if CONFIG.api_key is None:
+        if key := os.getenv("OPENROUTER_API_KEY"):
+            CONFIG.api_key = key
+        else:
+            rich.print(
+                "[bold red]Error:[/bold red] [red]No API key found. Please set the OPENROUTER_API_KEY environment variable or add it to your config file.[/red]"
+            )
+            sys.exit(1)
+    try:
+        asyncio.run(start_session(prompt, args))
+    except (KeyboardInterrupt, EOFError):
+        rich.print("\n[red]Aborted.[/red]")
+        sys.exit(1)