prompt-copilot-cli 0.1.1__py3-none-any.whl

prompt_copilot_cli-0.1.1.dist-info/METADATA

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: prompt-copilot-cli
+Version: 0.1.1
+Summary: A lightweight terminal-based coding agent with file tools, command execution, multimodal image support, and MCP integration.
+Author: Jason Li
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/woshiliyihang/prompt-copilot-cli
+Project-URL: Repository, https://github.com/woshiliyihang/prompt-copilot-cli
+Project-URL: Issues, https://github.com/woshiliyihang/prompt-copilot-cli/issues
+Keywords: cli,agent,openai,mcp,coding-assistant
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+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 :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp==1.28.0
+Requires-Dist: openai==1.109.1
+Requires-Dist: prompt_toolkit==3.0.52
+Requires-Dist: rich==15.0.0
+Dynamic: license-file
+
+# Prompt Copilot CLI
+
+Prompt Copilot CLI is a lightweight terminal-based coding agent for local development workflows. It combines an OpenAI-compatible model with a set of practical tools for file operations, shell commands, Python execution, multimodal image handling, and MCP integrations.
+
+It is designed for developers who want an interactive coding assistant that can inspect a workspace, edit files, run commands, and help turn multi-step conversations into a final, actionable prompt.
+
+## ✨ Features
+
+- Interactive CLI experience in the terminal
+- Persistent session history and conversation logs
+- File-system tools for reading, writing, deleting, renaming, copying, and recursive directory listing
+- Shell command execution and Python script execution
+- Image support for vision-capable models via image-to-base64 conversion
+- MCP tool integration for extending the agent with external tools
+- Task workflow with `/task-start` and `/task-end` to generate a polished final prompt
+
+## 🚀 Quick Start
+
+### 1. Install dependencies
+
+```powershell
+py -m pip install -r requirements.txt
+```
+
+### 2. Configure the model
+
+On first launch, the project creates a configuration file at:
+
+- Windows: `%USERPROFILE%\.prompt-copilot\config.json`
+- Linux/macOS: `~/.prompt-copilot/config.json`
+
+Example:
+
+```json
+{
+  "model": "gpt-4o-mini",
+  "base_url": "http://127.0.0.1:11434/v1",
+  "api_key": "dummy",
+  "temperature": 0.2,
+  "debug": false,
+  "mcp": {
+    "enabled": true,
+    "servers": []
+  }
+}
+```
+
+### 3. MCP configuration (optional)
+
+The agent can discover and use external MCP tools through the `mcp.servers` array. This is useful when you want to extend the agent with tools such as web search, filesystem helpers, or other local services.
+
+Example configuration:
+
+```json
+{
+  "mcp": {
+    "enabled": true,
+    "servers": [
+      {
+        "name": "bing",
+        "command": "npx",
+        "args": ["-y", "bing-cn-mcp"]
+      },
+      {
+        "name": "open-websearch-http",
+        "transport": "http",
+        "url": "http://127.0.0.1:3000/mcp"
+      }
+    ]
+  }
+}
+```
+
+How it works:
+
+- The first server uses a local stdio-based MCP server launched by `npx`.
+- The second server connects to an HTTP MCP endpoint at the given URL.
+- Once discovered, the tools exposed by these servers become callable by the agent during a session.
+- If `enabled` is set to `false` or the server list is empty, no MCP tools will be loaded.
+
+### 4. Run the agent
+
+Interactive mode:
+
+```powershell
+py main.py
+```
+
+One-off task mode:
+
+```powershell
+py main.py -t "Create a simple HTML landing page" -d ./workspace -l en
+```
+
+## 🧭 Usage Guide
+
+### Interactive commands
+
+Once the CLI starts, you can use these commands:
+
+- `/exit` — quit the program
+- `/clear` — clear local session history
+- `/task-start` — start a task context for later summarization
+- `/task-end` — generate a final optimized prompt and save it to `last-prompt.md`
+
+### Common startup options
+
+```powershell
+py main.py -h
+```
+
+Key options:
+
+- `-t, --task` — one-off task content
+- `-d, --workdir` — working directory
+- `-l, --lang` — language (`zh` or `en`)
+- `-amc, --agent-messages-count` — number of messages kept in agent history
+- `-rd, --request-delay` — delay between model requests in seconds
+- `-hc, --history-count` — number of rounds kept in conversation history
+- `--reset-session` — reset persisted session history
+
+### Example workflows
+
+#### 1. Ask the agent to inspect a project
+
+```powershell
+py main.py -t "Inspect this repository and summarize the main structure" -d ./workspace
+```
+
+#### 2. Ask the agent to edit files and run tests
+
+```powershell
+py main.py -t "Update the code, then run the relevant test suite" -d ./workspace
+```
+
+#### 3. Ask the agent to analyze an image
+
+If your model supports vision, the agent can use the built-in image tool to read an image file and convert it to base64 for multimodal input.
+
+Example prompt:
+
+```text
+Please inspect the image in ./workspace/demo.png and tell me what numbers or text are visible.
+```
+
+## 🛠 Tool capabilities
+
+The agent can call the following tools:
+
+- File tools
+  - `read_file`
+  - `write_file`
+  - `delete_file`
+  - `create_directory`
+  - `delete_directory`
+  - `rename_path`
+  - `copy_file`
+  - `list_dir` (with recursive option)
+- Execution tools
+  - `execute_command`
+  - `execute_python_script`
+- Multimodal tools
+  - `read_image_as_base64`
+
+## 🧠 Task flow
+
+The project supports a lightweight task-iteration workflow:
+
+1. Start a round with `/task-start`
+2. Continue interacting with the agent to clarify requirements or refine the task
+3. Finish with `/task-end`
+4. The agent writes the final prompt to `last-prompt.md`
+
+This is useful when you want to turn a long back-and-forth conversation into a compact, executable prompt.
+
+## 📁 Project structure
+
+```text
+.
+├── main.py
+├── requirements.txt
+├── README.md
+├── README.zh-CN.md
+├── tests/
+└── workspace/
+```
+
+## 🤝 Contributing
+
+Contributions are welcome. Please feel free to open an issue or submit a pull request if you have suggestions, bug reports, or new workflow ideas.
+
+## 📄 License
+
+This project does not currently declare a specific license. If you plan to distribute or reuse it publicly, please add an appropriate license file.

prompt_copilot_cli-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+main.py,sha256=fyu5U1vh2sfwVH10rosplFBfK_11IcaRrcd6l1w_zqY,81118
+prompt_copilot_cli-0.1.1.dist-info/licenses/LICENSE,sha256=Rvixi9qoeddH5yr2s2CaBwffLtjqk79v76ImiNqcSGI,1086
+prompt_copilot_cli-0.1.1.dist-info/METADATA,sha256=u6_x1HWNuZgSjsHsjQtZdzRSCJjQcbSi-Ii3_4DhoQ8,6710
+prompt_copilot_cli-0.1.1.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+prompt_copilot_cli-0.1.1.dist-info/entry_points.txt,sha256=lWtsqbdYCvmtNReni_ICoi1N0DD-tCfmWVb0fRoDGNk,45
+prompt_copilot_cli-0.1.1.dist-info/top_level.txt,sha256=ZAMgPdWghn6xTRBO6Kc3ML1y3ZrZLnjZlqbboKXc_AE,5
+prompt_copilot_cli-0.1.1.dist-info/RECORD,,

prompt_copilot_cli-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

prompt_copilot_cli-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+prompt-copilot = main:main

prompt_copilot_cli-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jason Li
+
+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.

prompt_copilot_cli-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+main