cmdo-cli 0.1.0__tar.gz

cmdo_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yijiang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmdo_cli-0.1.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: cmdo-cli
+Version: 0.1.0
+Summary: Natural language to shell commands — just say what you want and cmdo does it.
+Author: Yijiang Pang
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/YijiangPang/cmdo
+Project-URL: Repository, https://github.com/YijiangPang/cmdo
+Project-URL: Issues, https://github.com/YijiangPang/cmdo/issues
+Keywords: cli,terminal,ai,shell,natural-language,command-line,openai,gpt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: openai>=1.0
+Requires-Dist: tomli>=2.0; python_version < "3.11"
+Requires-Dist: tomli-w>=1.0
+Requires-Dist: pyperclip>=1.8
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# cmdo
+
+**Natural language to shell commands.** Just say what you want and cmdo does it.
+
+```
+$ cmdo "compress the checkpoints folder"
+
+🤖 Will run:
+╭──────────────────────────────────────────────╮
+│ tar -czf checkpoints.tar.gz checkpoints/     │
+╰──────────────────────────────────────────────╯
+📝 Compresses the "checkpoints" directory into a gzipped tarball.
+
+[Y] Execute  [e] Edit  [c] Copy  [n] Cancel
+```
+
+## Features
+
+- **Translates natural language** into accurate shell commands using GPT
+- **Safety-first**: commands are classified as Safe / Caution / Dangerous with color-coded warnings
+- **Hard-blocks** catastrophic commands (fork bombs, `rm -rf /`, disk wipes)
+- **Context-aware**: knows your OS, shell, current directory, installed tools, and git branch
+- **Works everywhere**: any terminal — iTerm, VSCode, Terminal.app, SSH, tmux
+
+## Install
+
+```bash
+pip install cmdo
+```
+
+Requires Python 3.10+.
+
+## Quick Start
+
+```bash
+# First-time setup — enter your OpenAI API key
+cmdo --config
+
+# Use it
+cmdo "find all Python files larger than 1MB"
+cmdo "start a local HTTP server on port 8080"
+cmdo "show disk usage sorted by size"
+
+# Generate without executing
+cmdo --dry-run "delete the temp folder"
+
+# Auto-confirm safe commands
+cmdo --yes "list all docker containers"
+```
+
+## Safety
+
+Every generated command goes through two layers of safety checking:
+
+1. **LLM classification** — the model labels each command as SAFE, CAUTION, or DANGEROUS
+2. **Local pattern matching** — a regex-based classifier catches anything the LLM misses
+
+| Risk Level | Confirmation | Auto-confirm (`--yes`) |
+|---|---|---|
+| **SAFE** (green) | Single keypress `Y` | Allowed |
+| **CAUTION** (yellow) | Single keypress `Y` | Allowed |
+| **DANGEROUS** (red) | Type full word `yes` | Never |
+
+Certain commands are **hard-blocked** and can never be executed:
+- Fork bombs
+- Full disk wipes (`dd if=/dev/zero of=/dev/sda`)
+- System-wide deletion (`rm -rf /`)
+
+## Configuration
+
+```bash
+cmdo --config           # Interactive setup wizard
+cmdo --config --show    # View current config (API key masked)
+cmdo --config --reset   # Reset to defaults
+```
+
+Config is stored in `~/.config/cmdo/config.toml`.
+
+## CLI Reference
+
+```
+Usage: cmdo [OPTIONS] [QUERY]...
+
+Options:
+  --config          Configure cmdo
+  --show            Show current configuration (use with --config)
+  --reset           Reset configuration (use with --config)
+  -d, --dry-run     Generate command without executing
+  -y, --yes         Auto-confirm safe commands
+  -m, --model TEXT  Override default model for one query
+  -V, --version     Show version
+  --help            Show help
+```
+
+## License
+
+MIT

cmdo_cli-0.1.0/README.md

@@ -0,0 +1,97 @@
+# cmdo
+
+**Natural language to shell commands.** Just say what you want and cmdo does it.
+
+```
+$ cmdo "compress the checkpoints folder"
+
+🤖 Will run:
+╭──────────────────────────────────────────────╮
+│ tar -czf checkpoints.tar.gz checkpoints/     │
+╰──────────────────────────────────────────────╯
+📝 Compresses the "checkpoints" directory into a gzipped tarball.
+
+[Y] Execute  [e] Edit  [c] Copy  [n] Cancel
+```
+
+## Features
+
+- **Translates natural language** into accurate shell commands using GPT
+- **Safety-first**: commands are classified as Safe / Caution / Dangerous with color-coded warnings
+- **Hard-blocks** catastrophic commands (fork bombs, `rm -rf /`, disk wipes)
+- **Context-aware**: knows your OS, shell, current directory, installed tools, and git branch
+- **Works everywhere**: any terminal — iTerm, VSCode, Terminal.app, SSH, tmux
+
+## Install
+
+```bash
+pip install cmdo
+```
+
+Requires Python 3.10+.
+
+## Quick Start
+
+```bash
+# First-time setup — enter your OpenAI API key
+cmdo --config
+
+# Use it
+cmdo "find all Python files larger than 1MB"
+cmdo "start a local HTTP server on port 8080"
+cmdo "show disk usage sorted by size"
+
+# Generate without executing
+cmdo --dry-run "delete the temp folder"
+
+# Auto-confirm safe commands
+cmdo --yes "list all docker containers"
+```
+
+## Safety
+
+Every generated command goes through two layers of safety checking:
+
+1. **LLM classification** — the model labels each command as SAFE, CAUTION, or DANGEROUS
+2. **Local pattern matching** — a regex-based classifier catches anything the LLM misses
+
+| Risk Level | Confirmation | Auto-confirm (`--yes`) |
+|---|---|---|
+| **SAFE** (green) | Single keypress `Y` | Allowed |
+| **CAUTION** (yellow) | Single keypress `Y` | Allowed |
+| **DANGEROUS** (red) | Type full word `yes` | Never |
+
+Certain commands are **hard-blocked** and can never be executed:
+- Fork bombs
+- Full disk wipes (`dd if=/dev/zero of=/dev/sda`)
+- System-wide deletion (`rm -rf /`)
+
+## Configuration
+
+```bash
+cmdo --config           # Interactive setup wizard
+cmdo --config --show    # View current config (API key masked)
+cmdo --config --reset   # Reset to defaults
+```
+
+Config is stored in `~/.config/cmdo/config.toml`.
+
+## CLI Reference
+
+```
+Usage: cmdo [OPTIONS] [QUERY]...
+
+Options:
+  --config          Configure cmdo
+  --show            Show current configuration (use with --config)
+  --reset           Reset configuration (use with --config)
+  -d, --dry-run     Generate command without executing
+  -y, --yes         Auto-confirm safe commands
+  -m, --model TEXT  Override default model for one query
+  -V, --version     Show version
+  --help            Show help
+```
+
+## License
+
+MIT

cmdo_cli-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["setuptools>=68.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cmdo-cli"
+version = "0.1.0"
+description = "Natural language to shell commands — just say what you want and cmdo does it."
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+authors = [
+    {name = "Yijiang Pang"},
+]
+keywords = ["cli", "terminal", "ai", "shell", "natural-language", "command-line", "openai", "gpt"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: System :: Shells",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "click>=8.0",
+    "rich>=13.0",
+    "openai>=1.0",
+    "tomli>=2.0; python_version < '3.11'",
+    "tomli-w>=1.0",
+    "pyperclip>=1.8",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-mock>=3.0",
+    "build",
+    "twine",
+]
+
+[project.urls]
+Homepage = "https://github.com/YijiangPang/cmdo"
+Repository = "https://github.com/YijiangPang/cmdo"
+Issues = "https://github.com/YijiangPang/cmdo/issues"
+
+[project.scripts]
+cmdo = "cmdo.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

cmdo_cli-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cmdo_cli-0.1.0/src/cmdo/__init__.py

@@ -0,0 +1,3 @@
+"""cmdo — Natural language to shell commands."""
+
+__version__ = "0.1.0"

cmdo_cli-0.1.0/src/cmdo/cli.py

@@ -0,0 +1,174 @@
+"""CLI entry point for cmdo."""
+
+from __future__ import annotations
+
+import sys
+
+import click
+from rich.console import Console
+
+from cmdo import __version__
+
+console = Console()
+
+
+@click.command(context_settings={"ignore_unknown_options": True})
+@click.argument("query", nargs=-1)
+@click.option("--config", "do_config", is_flag=True, help="Configure cmdo")
+@click.option("--show", is_flag=True, help="Show current configuration (use with --config)")
+@click.option("--reset", is_flag=True, help="Reset configuration (use with --config)")
+@click.option("--dry-run", "-d", is_flag=True, help="Generate command without executing")
+@click.option("--yes", "-y", is_flag=True, help="Auto-confirm safe commands")
+@click.option("--model", "-m", default=None, help="Override default model")
+@click.option("--version", "-V", is_flag=True, help="Show version")
+def main(
+    query: tuple[str, ...],
+    do_config: bool,
+    show: bool,
+    reset: bool,
+    dry_run: bool,
+    yes: bool,
+    model: str | None,
+    version: bool,
+) -> None:
+    """cmdo — Natural language to shell commands.
+
+    \b
+    Examples:
+      cmdo "find all Python files larger than 1MB"
+      cmdo "start a local HTTP server on port 8080"
+      cmdo --explain "tar -czf archive.tar.gz dir/"
+      cmdo --dry-run "delete the temp folder"
+    """
+    if version:
+        click.echo(f"cmdo v{__version__}")
+        return
+
+    # Config management
+    if do_config:
+        if show:
+            from cmdo.config import show_config
+            show_config()
+        elif reset:
+            from cmdo.config import reset_config
+            reset_config()
+        else:
+            from cmdo.config import configure
+            configure()
+        return
+
+    # No query provided
+    if not query:
+        click.echo(f"cmdo v{__version__} — Natural language to shell commands")
+        click.echo('Usage: cmdo "your instruction"')
+        click.echo("       cmdo --config        Set up or reconfigure")
+        click.echo("       cmdo --help          Show full help")
+        return
+
+    # Core flow
+    query_str = " ".join(query)
+    _run_query(query_str, dry_run=dry_run, auto_yes=yes, model_override=model)
+
+
+def _run_query(
+    query: str,
+    *,
+    dry_run: bool = False,
+    auto_yes: bool = False,
+    model_override: str | None = None,
+) -> None:
+    """Core flow: query → generate → display → confirm → execute."""
+    from cmdo.clipboard import copy_to_clipboard
+    from cmdo.config import ensure_configured
+    from cmdo.context import gather_context
+    from cmdo.display import (
+        display_command,
+        display_error,
+        display_execution_result,
+        display_forbidden,
+        edit_command,
+        prompt_user,
+    )
+    from cmdo.executor import execute_command
+    from cmdo.llm.client import generate_command
+    from cmdo.models import RiskLevel, UserAction
+    from cmdo.safety.classifier import classify_risk, upgrade_risk
+    from cmdo.safety.forbidden import check_forbidden
+
+    # 1. Ensure configured
+    config = ensure_configured()
+    if model_override:
+        config.model = model_override
+
+    # 2. Gather context
+    with console.status("[dim]Gathering context...[/dim]", spinner="dots"):
+        context = gather_context()
+
+    # 3. Generate command via LLM
+    try:
+        with console.status("[dim]Thinking...[/dim]", spinner="dots"):
+            result = generate_command(query, context, config)
+    except Exception as e:
+        display_error(f"Failed to generate command: {e}")
+        sys.exit(2)
+
+    if not result.command:
+        display_error("Could not generate a command for that request.")
+        sys.exit(1)
+
+    # 4. Safety checks
+    forbidden_msg = check_forbidden(result.command)
+    if forbidden_msg:
+        display_forbidden(forbidden_msg)
+        sys.exit(1)
+
+    local_risk, local_reason = classify_risk(result.command)
+    result.risk_level = upgrade_risk(result.risk_level, local_risk)
+    if local_reason and result.risk_reason is None:
+        result.risk_reason = local_reason
+
+    # 5. Display
+    display_command(result)
+
+    # 6. Dry run — stop here
+    if dry_run:
+        return
+
+    # 7. Auto-confirm if --yes flag or config auto_confirm_safe
+    if (auto_yes or config.auto_confirm_safe) and result.risk_level != RiskLevel.DANGEROUS:
+        action = UserAction.EXECUTE
+    else:
+        action = prompt_user(result)
+
+    # 8. Handle action
+    if action == UserAction.CANCEL:
+        console.print("[dim]Cancelled.[/dim]")
+        sys.exit(1)
+
+    if action == UserAction.COPY:
+        if copy_to_clipboard(result.command):
+            console.print("[green]📋 Copied to clipboard![/green]")
+        else:
+            console.print(f"[yellow]Could not copy. Here's the command:[/yellow]\n{result.command}")
+        return
+
+    if action == UserAction.EDIT:
+        edited = edit_command(result.command)
+        if edited != result.command:
+            # Re-check safety on edited command
+            forbidden_msg = check_forbidden(edited)
+            if forbidden_msg:
+                display_forbidden(forbidden_msg)
+                sys.exit(1)
+            result.command = edited
+
+    # 9. Execute
+    stepwise = action == UserAction.EXECUTE_STEPWISE
+    exec_result = execute_command(result.command, stepwise=stepwise)
+    display_execution_result(exec_result.exit_code, exec_result.duration)
+
+    sys.exit(0 if exec_result.exit_code == 0 else 2)
+
+
+if __name__ == "__main__":
+    main()

cmdo_cli-0.1.0/src/cmdo/clipboard.py

@@ -0,0 +1,14 @@
+"""Clipboard integration."""
+
+from __future__ import annotations
+
+
+def copy_to_clipboard(command: str) -> bool:
+    """Copy command to system clipboard. Returns True on success."""
+    try:
+        import pyperclip
+
+        pyperclip.copy(command)
+        return True
+    except Exception:
+        return False