ask2cmd 0.1.0__tar.gz

ask2cmd-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 askcmd contributors
+
+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.

ask2cmd-0.1.0/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: ask2cmd
+Version: 0.1.0
+Summary: Turn natural language into terminal commands.
+Author: askcmd contributors
+License: MIT
+Project-URL: Homepage, https://github.com/dovzilla/askcmd
+Project-URL: Repository, https://github.com/dovzilla/askcmd
+Keywords: cli,ai,terminal,openai,natural-language
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: openai>=1.0.0
+Dynamic: license-file
+
+<p align="center">
+  <h1 align="center">askcmd</h1>
+  <p align="center"><strong>Stop Googling. Start asking.</strong></p>
+  <p align="center">Turn natural language into terminal commands — right from your shell.</p>
+</p>
+
+<p align="center">
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python 3.8+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT License"></a>
+  <a href="https://github.com/dovzilla/askcmd/stargazers"><img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="GitHub Stars"></a>
+  <a href="https://github.com/dovzilla/askcmd/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
+</p>
+
+---
+
+## Demo
+
+```
+$ ask "list all docker containers"
+> docker ps -a
+
+$ ask "kill process on port 3000"
+> lsof -ti:3000 | xargs kill -9
+
+$ ask "find large files in this folder"
+> find . -type f -size +100M
+```
+
+<p align="center">
+  <img src="demo.gif" alt="askcmd demo" width="600">
+</p>
+
+---
+
+## Why This Exists
+
+You're a developer. You live in the terminal.
+
+And yet — every single day — you open a browser to Google things like:
+
+> *"how to find files larger than 100MB linux"*
+> *"tar compress folder command"*
+> *"kill process on port 3000 mac"*
+
+You know the command *exists*. You just can't remember the exact flags.
+
+**askcmd** fixes that. One tool. One command. No leaving the terminal.
+
+```bash
+ask "undo last git commit but keep changes"
+```
+
+That's it.
+
+---
+
+## Install
+
+```bash
+pip install ask2cmd
+```
+
+Then run the setup wizard to pick your provider and enter your API key:
+
+```bash
+ask setup
+```
+
+Choose from **OpenAI**, **DeepSeek**, or any OpenAI-compatible API:
+
+```
+选择你的 AI 服务商:
+
+  1) OpenAI
+  2) DeepSeek
+  3) Custom (OpenAI-compatible)
+```
+
+Done. You're ready.
+
+---
+
+## Examples
+
+This is where it gets fun.
+
+#### Everyday
+
+```bash
+ask "show disk usage sorted by size"
+ask "count lines of code in this project"
+ask "show my public IP"
+ask "what's using port 8080"
+```
+
+#### Git
+
+```bash
+ask "undo last commit but keep changes"
+ask "squash last 3 commits"
+ask "show commits from last week by me"
+ask "delete all merged branches"
+```
+
+#### Docker
+
+```bash
+ask "stop all running containers"
+ask "remove all dangling images"
+ask "show logs for container nginx"
+ask "list all volumes not used by any container"
+```
+
+#### Files & Search
+
+```bash
+ask "find all TODO comments in python files"
+ask "find files modified in the last 24 hours"
+ask "replace foo with bar in all js files"
+ask "find duplicate files in this folder"
+```
+
+#### System
+
+```bash
+ask "kill process on port 3000"
+ask "show top 10 processes by memory"
+ask "how much RAM is free"
+ask "list all open network connections"
+```
+
+#### Fun
+
+```bash
+ask "generate a random password 32 chars"
+ask "download this youtube video as mp3"  # you rebel
+ask "what's the weather in Tokyo from the terminal"
+```
+
+Every command is shown to you **before** it runs. You stay in control.
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Natural language** | Just describe what you want |
+| **OS-aware** | Detects macOS / Linux / Windows and adapts commands |
+| **Multi-provider** | OpenAI, DeepSeek, or any compatible API |
+| **Safe by default** | Always asks for confirmation before running |
+| `--explain` | Explains what the command does |
+| `--dry-run` | Shows the command without executing |
+| `--yes` | Skips confirmation (for the brave) |
+
+---
+
+## Safety
+
+**askcmd never runs anything without your permission.**
+
+Default flow:
+
+```
+$ ask "delete all node_modules recursively"
+
+╭──────────────────────────────────────────╮
+│ find . -name node_modules -type d        │
+│   -prune -exec rm -rf {} +               │
+╰──────────────────────────────────────────╯
+
+Run this command? [y/N]:
+```
+
+- **Default is N.** You must explicitly approve.
+- Use `--dry-run` to preview without any execution.
+- Use `--explain` to understand the command before running.
+- No telemetry. No data collection. Your queries go to *your* API provider and nowhere else.
+
+You are always in control.
+
+---
+
+## How It Works
+
+```
+  You                askcmd             LLM API           Terminal
+   │                   │                  │                  │
+   │  "kill port 3000" │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │  prompt + OS ctx │                  │
+   │                   │─────────────────>│                  │
+   │                   │  shell command   │                  │
+   │                   │<─────────────────│                  │
+   │  show command     │                  │                  │
+   │<──────────────────│                  │                  │
+   │  confirm (y/N)    │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │          execute │                  │
+   │                   │─────────────────────────────────────>
+   │                   │                  │          output  │
+   │<─────────────────────────────────────────────────────────
+```
+
+1. You describe what you want in plain English
+2. `askcmd` builds a prompt with your OS and shell context
+3. The LLM returns a single shell command (no markdown, no fluff)
+4. You review, confirm, and it runs — or you walk away
+
+No agents. No chains. No frameworks. Just one clean API call.
+
+---
+
+## Roadmap
+
+- [ ] Command history — recall and reuse past generations
+- [ ] Shell aliases — auto-create aliases for commands you use often
+- [ ] Offline mode — local models via Ollama
+- [ ] Plugins — community-contributed prompt packs
+- [ ] Clipboard mode — copy command instead of running
+- [ ] Multi-command — generate pipelines and scripts
+- [ ] i18n — prompts in any language
+
+Want to build one of these? PRs are open.
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/dovzilla/askcmd.git
+cd askcmd
+pip install -e .
+ask setup
+```
+
+That's the whole dev setup. Hack away.
+
+---
+
+## License
+
+MIT — do whatever you want with it.
+
+---
+
+<p align="center">
+  <br>
+  If this saves you even one Google search, give it a ⭐
+  <br><br>
+  <a href="https://github.com/dovzilla/askcmd">
+    <img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="Star on GitHub">
+  </a>
+</p>

ask2cmd-0.1.0/README.md

@@ -0,0 +1,254 @@
+<p align="center">
+  <h1 align="center">askcmd</h1>
+  <p align="center"><strong>Stop Googling. Start asking.</strong></p>
+  <p align="center">Turn natural language into terminal commands — right from your shell.</p>
+</p>
+
+<p align="center">
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python 3.8+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT License"></a>
+  <a href="https://github.com/dovzilla/askcmd/stargazers"><img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="GitHub Stars"></a>
+  <a href="https://github.com/dovzilla/askcmd/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
+</p>
+
+---
+
+## Demo
+
+```
+$ ask "list all docker containers"
+> docker ps -a
+
+$ ask "kill process on port 3000"
+> lsof -ti:3000 | xargs kill -9
+
+$ ask "find large files in this folder"
+> find . -type f -size +100M
+```
+
+<p align="center">
+  <img src="demo.gif" alt="askcmd demo" width="600">
+</p>
+
+---
+
+## Why This Exists
+
+You're a developer. You live in the terminal.
+
+And yet — every single day — you open a browser to Google things like:
+
+> *"how to find files larger than 100MB linux"*
+> *"tar compress folder command"*
+> *"kill process on port 3000 mac"*
+
+You know the command *exists*. You just can't remember the exact flags.
+
+**askcmd** fixes that. One tool. One command. No leaving the terminal.
+
+```bash
+ask "undo last git commit but keep changes"
+```
+
+That's it.
+
+---
+
+## Install
+
+```bash
+pip install ask2cmd
+```
+
+Then run the setup wizard to pick your provider and enter your API key:
+
+```bash
+ask setup
+```
+
+Choose from **OpenAI**, **DeepSeek**, or any OpenAI-compatible API:
+
+```
+选择你的 AI 服务商:
+
+  1) OpenAI
+  2) DeepSeek
+  3) Custom (OpenAI-compatible)
+```
+
+Done. You're ready.
+
+---
+
+## Examples
+
+This is where it gets fun.
+
+#### Everyday
+
+```bash
+ask "show disk usage sorted by size"
+ask "count lines of code in this project"
+ask "show my public IP"
+ask "what's using port 8080"
+```
+
+#### Git
+
+```bash
+ask "undo last commit but keep changes"
+ask "squash last 3 commits"
+ask "show commits from last week by me"
+ask "delete all merged branches"
+```
+
+#### Docker
+
+```bash
+ask "stop all running containers"
+ask "remove all dangling images"
+ask "show logs for container nginx"
+ask "list all volumes not used by any container"
+```
+
+#### Files & Search
+
+```bash
+ask "find all TODO comments in python files"
+ask "find files modified in the last 24 hours"
+ask "replace foo with bar in all js files"
+ask "find duplicate files in this folder"
+```
+
+#### System
+
+```bash
+ask "kill process on port 3000"
+ask "show top 10 processes by memory"
+ask "how much RAM is free"
+ask "list all open network connections"
+```
+
+#### Fun
+
+```bash
+ask "generate a random password 32 chars"
+ask "download this youtube video as mp3"  # you rebel
+ask "what's the weather in Tokyo from the terminal"
+```
+
+Every command is shown to you **before** it runs. You stay in control.
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Natural language** | Just describe what you want |
+| **OS-aware** | Detects macOS / Linux / Windows and adapts commands |
+| **Multi-provider** | OpenAI, DeepSeek, or any compatible API |
+| **Safe by default** | Always asks for confirmation before running |
+| `--explain` | Explains what the command does |
+| `--dry-run` | Shows the command without executing |
+| `--yes` | Skips confirmation (for the brave) |
+
+---
+
+## Safety
+
+**askcmd never runs anything without your permission.**
+
+Default flow:
+
+```
+$ ask "delete all node_modules recursively"
+
+╭──────────────────────────────────────────╮
+│ find . -name node_modules -type d        │
+│   -prune -exec rm -rf {} +               │
+╰──────────────────────────────────────────╯
+
+Run this command? [y/N]:
+```
+
+- **Default is N.** You must explicitly approve.
+- Use `--dry-run` to preview without any execution.
+- Use `--explain` to understand the command before running.
+- No telemetry. No data collection. Your queries go to *your* API provider and nowhere else.
+
+You are always in control.
+
+---
+
+## How It Works
+
+```
+  You                askcmd             LLM API           Terminal
+   │                   │                  │                  │
+   │  "kill port 3000" │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │  prompt + OS ctx │                  │
+   │                   │─────────────────>│                  │
+   │                   │  shell command   │                  │
+   │                   │<─────────────────│                  │
+   │  show command     │                  │                  │
+   │<──────────────────│                  │                  │
+   │  confirm (y/N)    │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │          execute │                  │
+   │                   │─────────────────────────────────────>
+   │                   │                  │          output  │
+   │<─────────────────────────────────────────────────────────
+```
+
+1. You describe what you want in plain English
+2. `askcmd` builds a prompt with your OS and shell context
+3. The LLM returns a single shell command (no markdown, no fluff)
+4. You review, confirm, and it runs — or you walk away
+
+No agents. No chains. No frameworks. Just one clean API call.
+
+---
+
+## Roadmap
+
+- [ ] Command history — recall and reuse past generations
+- [ ] Shell aliases — auto-create aliases for commands you use often
+- [ ] Offline mode — local models via Ollama
+- [ ] Plugins — community-contributed prompt packs
+- [ ] Clipboard mode — copy command instead of running
+- [ ] Multi-command — generate pipelines and scripts
+- [ ] i18n — prompts in any language
+
+Want to build one of these? PRs are open.
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/dovzilla/askcmd.git
+cd askcmd
+pip install -e .
+ask setup
+```
+
+That's the whole dev setup. Hack away.
+
+---
+
+## License
+
+MIT — do whatever you want with it.
+
+---
+
+<p align="center">
+  <br>
+  If this saves you even one Google search, give it a ⭐
+  <br><br>
+  <a href="https://github.com/dovzilla/askcmd">
+    <img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="Star on GitHub">
+  </a>
+</p>

ask2cmd-0.1.0/ask2cmd.egg-info/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: ask2cmd
+Version: 0.1.0
+Summary: Turn natural language into terminal commands.
+Author: askcmd contributors
+License: MIT
+Project-URL: Homepage, https://github.com/dovzilla/askcmd
+Project-URL: Repository, https://github.com/dovzilla/askcmd
+Keywords: cli,ai,terminal,openai,natural-language
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer>=0.9.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: openai>=1.0.0
+Dynamic: license-file
+
+<p align="center">
+  <h1 align="center">askcmd</h1>
+  <p align="center"><strong>Stop Googling. Start asking.</strong></p>
+  <p align="center">Turn natural language into terminal commands — right from your shell.</p>
+</p>
+
+<p align="center">
+  <a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/python-3.8+-blue.svg" alt="Python 3.8+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT License"></a>
+  <a href="https://github.com/dovzilla/askcmd/stargazers"><img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="GitHub Stars"></a>
+  <a href="https://github.com/dovzilla/askcmd/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome"></a>
+</p>
+
+---
+
+## Demo
+
+```
+$ ask "list all docker containers"
+> docker ps -a
+
+$ ask "kill process on port 3000"
+> lsof -ti:3000 | xargs kill -9
+
+$ ask "find large files in this folder"
+> find . -type f -size +100M
+```
+
+<p align="center">
+  <img src="demo.gif" alt="askcmd demo" width="600">
+</p>
+
+---
+
+## Why This Exists
+
+You're a developer. You live in the terminal.
+
+And yet — every single day — you open a browser to Google things like:
+
+> *"how to find files larger than 100MB linux"*
+> *"tar compress folder command"*
+> *"kill process on port 3000 mac"*
+
+You know the command *exists*. You just can't remember the exact flags.
+
+**askcmd** fixes that. One tool. One command. No leaving the terminal.
+
+```bash
+ask "undo last git commit but keep changes"
+```
+
+That's it.
+
+---
+
+## Install
+
+```bash
+pip install ask2cmd
+```
+
+Then run the setup wizard to pick your provider and enter your API key:
+
+```bash
+ask setup
+```
+
+Choose from **OpenAI**, **DeepSeek**, or any OpenAI-compatible API:
+
+```
+选择你的 AI 服务商:
+
+  1) OpenAI
+  2) DeepSeek
+  3) Custom (OpenAI-compatible)
+```
+
+Done. You're ready.
+
+---
+
+## Examples
+
+This is where it gets fun.
+
+#### Everyday
+
+```bash
+ask "show disk usage sorted by size"
+ask "count lines of code in this project"
+ask "show my public IP"
+ask "what's using port 8080"
+```
+
+#### Git
+
+```bash
+ask "undo last commit but keep changes"
+ask "squash last 3 commits"
+ask "show commits from last week by me"
+ask "delete all merged branches"
+```
+
+#### Docker
+
+```bash
+ask "stop all running containers"
+ask "remove all dangling images"
+ask "show logs for container nginx"
+ask "list all volumes not used by any container"
+```
+
+#### Files & Search
+
+```bash
+ask "find all TODO comments in python files"
+ask "find files modified in the last 24 hours"
+ask "replace foo with bar in all js files"
+ask "find duplicate files in this folder"
+```
+
+#### System
+
+```bash
+ask "kill process on port 3000"
+ask "show top 10 processes by memory"
+ask "how much RAM is free"
+ask "list all open network connections"
+```
+
+#### Fun
+
+```bash
+ask "generate a random password 32 chars"
+ask "download this youtube video as mp3"  # you rebel
+ask "what's the weather in Tokyo from the terminal"
+```
+
+Every command is shown to you **before** it runs. You stay in control.
+
+---
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Natural language** | Just describe what you want |
+| **OS-aware** | Detects macOS / Linux / Windows and adapts commands |
+| **Multi-provider** | OpenAI, DeepSeek, or any compatible API |
+| **Safe by default** | Always asks for confirmation before running |
+| `--explain` | Explains what the command does |
+| `--dry-run` | Shows the command without executing |
+| `--yes` | Skips confirmation (for the brave) |
+
+---
+
+## Safety
+
+**askcmd never runs anything without your permission.**
+
+Default flow:
+
+```
+$ ask "delete all node_modules recursively"
+
+╭──────────────────────────────────────────╮
+│ find . -name node_modules -type d        │
+│   -prune -exec rm -rf {} +               │
+╰──────────────────────────────────────────╯
+
+Run this command? [y/N]:
+```
+
+- **Default is N.** You must explicitly approve.
+- Use `--dry-run` to preview without any execution.
+- Use `--explain` to understand the command before running.
+- No telemetry. No data collection. Your queries go to *your* API provider and nowhere else.
+
+You are always in control.
+
+---
+
+## How It Works
+
+```
+  You                askcmd             LLM API           Terminal
+   │                   │                  │                  │
+   │  "kill port 3000" │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │  prompt + OS ctx │                  │
+   │                   │─────────────────>│                  │
+   │                   │  shell command   │                  │
+   │                   │<─────────────────│                  │
+   │  show command     │                  │                  │
+   │<──────────────────│                  │                  │
+   │  confirm (y/N)    │                  │                  │
+   │──────────────────>│                  │                  │
+   │                   │          execute │                  │
+   │                   │─────────────────────────────────────>
+   │                   │                  │          output  │
+   │<─────────────────────────────────────────────────────────
+```
+
+1. You describe what you want in plain English
+2. `askcmd` builds a prompt with your OS and shell context
+3. The LLM returns a single shell command (no markdown, no fluff)
+4. You review, confirm, and it runs — or you walk away
+
+No agents. No chains. No frameworks. Just one clean API call.
+
+---
+
+## Roadmap
+
+- [ ] Command history — recall and reuse past generations
+- [ ] Shell aliases — auto-create aliases for commands you use often
+- [ ] Offline mode — local models via Ollama
+- [ ] Plugins — community-contributed prompt packs
+- [ ] Clipboard mode — copy command instead of running
+- [ ] Multi-command — generate pipelines and scripts
+- [ ] i18n — prompts in any language
+
+Want to build one of these? PRs are open.
+
+---
+
+## Contributing
+
+```bash
+git clone https://github.com/dovzilla/askcmd.git
+cd askcmd
+pip install -e .
+ask setup
+```
+
+That's the whole dev setup. Hack away.
+
+---
+
+## License
+
+MIT — do whatever you want with it.
+
+---
+
+<p align="center">
+  <br>
+  If this saves you even one Google search, give it a ⭐
+  <br><br>
+  <a href="https://github.com/dovzilla/askcmd">
+    <img src="https://img.shields.io/github/stars/dovzilla/askcmd?style=social" alt="Star on GitHub">
+  </a>
+</p>

ask2cmd-0.1.0/ask2cmd.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+LICENSE
+README.md
+pyproject.toml
+ask2cmd.egg-info/PKG-INFO
+ask2cmd.egg-info/SOURCES.txt
+ask2cmd.egg-info/dependency_links.txt
+ask2cmd.egg-info/entry_points.txt
+ask2cmd.egg-info/requires.txt
+ask2cmd.egg-info/top_level.txt
+askcmd/__init__.py
+askcmd/ai.py
+askcmd/config.py
+askcmd/executor.py
+askcmd/main.py
+askcmd/prompts.py
+askcmd/utils.py

ask2cmd-0.1.0/ask2cmd.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ask2cmd-0.1.0/ask2cmd.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ask = askcmd.main:entry

ask2cmd-0.1.0/ask2cmd.egg-info/requires.txt

@@ -0,0 +1,3 @@
+typer>=0.9.0
+rich>=13.0.0
+openai>=1.0.0

ask2cmd-0.1.0/ask2cmd.egg-info/top_level.txt

@@ -0,0 +1 @@
+askcmd

ask2cmd-0.1.0/askcmd/__init__.py

@@ -0,0 +1,3 @@
+"""askcmd — Turn natural language into terminal commands."""
+
+__version__ = "0.1.0"

ask2cmd-0.1.0/askcmd/ai.py

@@ -0,0 +1,53 @@
+"""Thin wrapper around OpenAI-compatible chat completions APIs."""
+
+from openai import OpenAI
+
+from .config import get_config
+from .prompts import EXPLAIN_PROMPT, SYSTEM_PROMPT
+from .utils import get_os_info
+
+
+def _client() -> tuple[OpenAI, str]:
+    """Build an OpenAI client from the saved config and return (client, model)."""
+    cfg = get_config()
+    client = OpenAI(
+        api_key=cfg["api_key"],
+        base_url=cfg["base_url"],
+    )
+    return client, cfg["model"]
+
+
+def generate_command(query: str) -> str:
+    """Send a natural-language query and return a shell command string."""
+    client, model = _client()
+    os_info = get_os_info()
+
+    response = client.chat.completions.create(
+        model=model,
+        temperature=0,
+        max_tokens=256,
+        messages=[
+            {"role": "system", "content": SYSTEM_PROMPT.format(**os_info)},
+            {"role": "user", "content": query},
+        ],
+    )
+    return response.choices[0].message.content.strip()
+
+
+def explain_command(command: str) -> str:
+    """Ask the model to explain a shell command in plain English."""
+    client, model = _client()
+    os_info = get_os_info()
+
+    response = client.chat.completions.create(
+        model=model,
+        temperature=0,
+        max_tokens=512,
+        messages=[
+            {
+                "role": "user",
+                "content": EXPLAIN_PROMPT.format(command=command, **os_info),
+            },
+        ],
+    )
+    return response.choices[0].message.content.strip()

ask2cmd-0.1.0/askcmd/config.py

@@ -0,0 +1,131 @@
+"""Configuration management — provider selection and API key storage."""
+
+import json
+from pathlib import Path
+from typing import Optional
+
+from rich.console import Console
+from rich.panel import Panel
+from rich.prompt import Prompt
+
+CONFIG_DIR = Path.home() / ".askcmd"
+CONFIG_FILE = CONFIG_DIR / "config.json"
+
+PROVIDERS = {
+    "openai": {
+        "name": "OpenAI",
+        "base_url": "https://api.openai.com/v1",
+        "default_model": "gpt-4o-mini",
+        "key_hint": "sk-...",
+    },
+    "deepseek": {
+        "name": "DeepSeek",
+        "base_url": "https://api.deepseek.com",
+        "default_model": "deepseek-chat",
+        "key_hint": "sk-...",
+    },
+    "custom": {
+        "name": "Custom (OpenAI-compatible)",
+        "base_url": "",
+        "default_model": "",
+        "key_hint": "your-api-key",
+    },
+}
+
+console = Console()
+
+
+def load_config() -> dict:
+    """Load config from disk, or return empty dict."""
+    if CONFIG_FILE.exists():
+        return json.loads(CONFIG_FILE.read_text())
+    return {}
+
+
+def save_config(cfg: dict) -> None:
+    """Persist config to ~/.askcmd/config.json."""
+    CONFIG_DIR.mkdir(parents=True, exist_ok=True)
+    CONFIG_FILE.write_text(json.dumps(cfg, indent=2) + "\n")
+
+
+def get_config() -> dict:
+    """Return a validated config. Abort with helpful message if not set up."""
+    cfg = load_config()
+    if not cfg.get("api_key"):
+        console.print()
+        console.print(
+            Panel(
+                "[bold yellow]还没有配置 API Key[/bold yellow]\n"
+                "请先运行:  [cyan bold]ask setup[/cyan bold]",
+                border_style="yellow",
+            )
+        )
+        raise SystemExit(1)
+    return cfg
+
+
+def run_setup() -> None:
+    """Interactive setup wizard — choose provider, enter API key."""
+    console.print()
+    console.print(Panel("[bold]askcmd 配置向导[/bold]", border_style="blue"))
+    console.print()
+
+    # --- Provider selection ---
+    console.print("[bold]选择你的 AI 服务商:[/bold]\n")
+    choices = list(PROVIDERS.keys())
+    for i, key in enumerate(choices, 1):
+        p = PROVIDERS[key]
+        console.print(f"  [cyan bold]{i}[/cyan bold]) {p['name']}")
+    console.print()
+
+    choice = Prompt.ask(
+        "[bold]请输入编号[/bold]",
+        choices=[str(i) for i in range(1, len(choices) + 1)],
+        default="1",
+    )
+    provider_key = choices[int(choice) - 1]
+    provider = PROVIDERS[provider_key]
+
+    # --- Base URL (custom only) ---
+    if provider_key == "custom":
+        base_url = Prompt.ask("\n[bold]输入 API Base URL[/bold]")
+        model = Prompt.ask("[bold]输入模型名称[/bold]")
+    else:
+        base_url = provider["base_url"]
+        model = provider["default_model"]
+        console.print(f"\n  Provider : [green]{provider['name']}[/green]")
+        console.print(f"  Base URL : [dim]{base_url}[/dim]")
+        console.print(f"  Model    : [dim]{model}[/dim]")
+
+    # --- API Key ---
+    console.print()
+    api_key = Prompt.ask(
+        f"[bold]输入你的 API Key[/bold] [dim]({provider['key_hint']})[/dim]",
+        password=True,
+    )
+
+    if not api_key.strip():
+        console.print("[red]API Key 不能为空，配置取消。[/red]")
+        raise SystemExit(1)
+
+    # --- Save ---
+    cfg = {
+        "provider": provider_key,
+        "provider_name": provider["name"],
+        "base_url": base_url,
+        "model": model,
+        "api_key": api_key.strip(),
+    }
+    save_config(cfg)
+
+    console.print()
+    console.print(
+        Panel(
+            f"[bold green]配置完成![/bold green]\n\n"
+            f"  服务商 : {cfg['provider_name']}\n"
+            f"  模型   : {cfg['model']}\n"
+            f"  配置文件 : [dim]{CONFIG_FILE}[/dim]\n\n"
+            f"现在可以使用了:  [cyan bold]ask \"list files\"[/cyan bold]",
+            border_style="green",
+        )
+    )

ask2cmd-0.1.0/askcmd/executor.py

@@ -0,0 +1,21 @@
+"""Safe subprocess execution."""
+
+import subprocess
+import sys
+
+
+def run_command(command: str) -> int:
+    """Execute *command* in the user's shell and return the exit code."""
+    try:
+        result = subprocess.run(
+            command,
+            shell=True,
+            text=True,
+        )
+        return result.returncode
+    except KeyboardInterrupt:
+        print("\nAborted.")
+        return 130
+    except Exception as exc:
+        print(f"Execution error: {exc}", file=sys.stderr)
+        return 1

ask2cmd-0.1.0/askcmd/main.py

@@ -0,0 +1,76 @@
+"""CLI entrypoint — the `ask` command."""
+
+import sys
+from typing import Optional
+
+import typer
+from rich.console import Console
+from rich.panel import Panel
+from rich.prompt import Confirm
+
+from . import __version__
+from .config import run_setup
+
+console = Console()
+
+# Main app — single-command mode for the cleanest UX.
+# `ask setup` is handled by intercepting argv before Typer runs.
+app = typer.Typer(
+    name="ask",
+    add_completion=False,
+    no_args_is_help=True,
+    rich_markup_mode="rich",
+)
+
+
+def version_callback(value: bool) -> None:
+    if value:
+        console.print(f"[bold]askcmd[/bold] v{__version__}")
+        raise typer.Exit()
+
+
+@app.command(
+    help="Turn natural language into terminal commands.",
+    epilog="Setup: [cyan]ask setup[/cyan]  ·  Example: [cyan]ask 'list all docker containers'[/cyan]",
+)
+def main(
+    query: str = typer.Argument(..., help="What you want to do, in plain English."),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation and execute immediately."),
+    explain: bool = typer.Option(False, "--explain", "-e", help="Explain the generated command."),
+    dry_run: bool = typer.Option(False, "--dry-run", "-n", help="Show the command but do not execute."),
+    version: Optional[bool] = typer.Option(None, "--version", "-v", callback=version_callback, is_eager=True, help="Show version and exit."),
+) -> None:
+    """Generate and optionally run a shell command from a natural-language query."""
+    from .ai import explain_command, generate_command
+    from .executor import run_command
+
+    with console.status("[bold green]Thinking…[/bold green]", spinner="dots"):
+        cmd = generate_command(query)
+
+    console.print()
+    console.print(Panel(f"[bold green]{cmd}[/bold green]", title="[bold]💡 Command[/bold]", border_style="green"))
+
+    if explain:
+        with console.status("[bold cyan]Explaining…[/bold cyan]", spinner="dots"):
+            explanation = explain_command(cmd)
+        console.print()
+        console.print(Panel(explanation, title="[bold]📖 Explanation[/bold]", border_style="cyan"))
+
+    if dry_run:
+        raise typer.Exit()
+
+    if yes or Confirm.ask("\n[bold]Run this command?[/bold]", default=False):
+        console.print()
+        exit_code = run_command(cmd)
+        if exit_code != 0:
+            console.print(f"\n[yellow]⚠ Command exited with code {exit_code}[/yellow]")
+    else:
+        console.print("[dim]Cancelled.[/dim]")
+
+
+def entry() -> None:
+    """Real entrypoint: intercept `ask setup` before Typer runs."""
+    if len(sys.argv) >= 2 and sys.argv[1] == "setup":
+        run_setup()
+    else:
+        app()

ask2cmd-0.1.0/askcmd/prompts.py

@@ -0,0 +1,25 @@
+"""Prompt templates for the OpenAI API."""
+
+SYSTEM_PROMPT = """\
+You are a terminal command generator.
+You run on {os_name} ({os_version}).
+The user's shell is {shell}.
+
+Rules:
+- Reply with ONLY the shell command. Nothing else.
+- No markdown, no backticks, no explanation.
+- One command (use && or | to chain if needed).
+- Prefer safe, non-destructive commands when possible.
+- If the request is ambiguous, pick the most common interpretation.
+"""
+
+EXPLAIN_PROMPT = """\
+You are a terminal command explainer.
+The user is running {os_name} ({os_version}) with {shell}.
+
+Given the following shell command, explain what it does in plain English.
+Be concise — use 2-4 short bullet points.
+
+Command:
+{command}
+"""

ask2cmd-0.1.0/askcmd/utils.py

@@ -0,0 +1,27 @@
+"""Utility helpers — OS detection."""
+
+import os
+import platform
+
+
+def get_os_info() -> dict[str, str]:
+    """Return a dict with os_name, os_version, and shell."""
+    system = platform.system().lower()
+    version = platform.version()
+
+    if system == "darwin":
+        os_name = "macOS"
+    elif system == "linux":
+        os_name = "Linux"
+    elif system == "windows":
+        os_name = "Windows"
+    else:
+        os_name = system
+
+    shell = os.environ.get("SHELL", "unknown")
+
+    return {
+        "os_name": os_name,
+        "os_version": version,
+        "shell": shell,
+    }

ask2cmd-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ask2cmd"
+version = "0.1.0"
+description = "Turn natural language into terminal commands."
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    {name = "askcmd contributors"},
+]
+keywords = ["cli", "ai", "terminal", "openai", "natural-language"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "typer>=0.9.0",
+    "rich>=13.0.0",
+    "openai>=1.0.0",
+]
+
+[project.scripts]
+ask = "askcmd.main:entry"
+
+[project.urls]
+Homepage = "https://github.com/dovzilla/askcmd"
+Repository = "https://github.com/dovzilla/askcmd"

ask2cmd-0.1.0/setup.cfg

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