Skip to main content

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, and run commands.

✨ Features

  • Interactive CLI experience in the terminal
  • In-memory conversation context (keeps the last 50 rounds; cleared when the program exits)
  • 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
  • Streaming model output with inline <think> tag filtering

🚀 Quick Start

1. Install the package

Install it from PyPI:

py -m pip install -U prompt-copilot-cli

The package installs a console command named prompt-copilot.

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:

{
  "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:

{
  "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

Normal node:

prompt-copilot -d D:\project_dir

Interactive mode:

prompt-copilot

One-off task mode:

prompt-copilot -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 the in-memory conversation history

Common startup options

prompt-copilot -h

Key options:

  • -t, --task — one-off task content
  • -d, --workdir — working directory
  • -l, --lang — language (zh or en)
  • -rd, --request-delay — delay between model requests in seconds

Example workflows

1. Ask the agent to inspect a project

prompt-copilot -t "Inspect this repository and summarize the main structure" -d ./workspace

2. Ask the agent to edit files and run tests

prompt-copilot -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:

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

📁 Project structure

.
├── 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

Apache License 2.0

Metadata

Release files for prompt-copilot-cli 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prompt-copilot-cli 0.8.0
File Size Uploaded Provenance Actions
prompt_copilot_cli-0.8.0.tar.gz 42.8 kB Without provenance Details for prompt_copilot_cli-0.8.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for prompt-copilot-cli 0.8.0
File Interpreter ABI Platform Actions
prompt_copilot_cli-0.8.0-py3-none-any.whl Python 3 none any Details for prompt_copilot_cli-0.8.0-py3-none-any.whl

Total release size: 79.3 kB

Release files / prompt_copilot_cli-0.8.0.tar.gz

Download URL prompt_copilot_cli-0.8.0.tar.gz
Size 42.8 kB
Tags Source
SHA-256 checksum
How to use checksums
e703428cd747d5f0a0d23dffe7860fa3fac12e8d5f1f3fef222a93a67369236b
BLAKE2b-256 checksum
How to use checksums
cc00c7f31cf761049ad9e1049414f321a69cdd0dea0ab75d31346cc662ad040a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / prompt_copilot_cli-0.8.0-py3-none-any.whl

Download URL prompt_copilot_cli-0.8.0-py3-none-any.whl
Size 36.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
462b869215d3316092903bcb829598dbe5f59b1efb673c796dc141515740c2d0
BLAKE2b-256 checksum
How to use checksums
fadfcfe125a52531b6cfa052ac070b35a2afbac482f34597b2a60a7d45f57d4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for prompt-copilot-cli 0.8.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page