Prepare CmdForge 0.2.0 for PyPI

This commit is contained in:
rob
2026-07-21 15:19:02 -03:00
parent ca6135ac72
commit 1e698996b2
12 changed files with 342 additions and 25 deletions
+20 -10
View File
@@ -55,16 +55,14 @@ That's it - you just used AI to explain itself. The `eli5` tool uses a free mode
For regular use, install natively:
```bash
# Clone and install
git clone https://gitea.brrd.tech/rob/CmdForge.git
cd CmdForge
pip install -e .
# Install the application with MCP and interactive-provider support
pipx install "cmdforge[mcp,pty]"
# Ensure ~/.local/bin is in PATH
export PATH="$HOME/.local/bin:$PATH"
# Install an AI provider (interactive guide)
cmdforge providers install
# Discover AI CLIs, API keys, and Ollama models already on this machine
cmdforge providers discover --add
# Launch the GUI
cmdforge
@@ -75,12 +73,24 @@ cmdforge create summarize
## Installation
### Native Install
### From PyPI
```bash
pipx install "cmdforge[mcp,pty]"
```
Or install into an active virtual environment:
```bash
python -m pip install "cmdforge[mcp,pty]"
```
### From Source
```bash
git clone https://gitea.brrd.tech/rob/CmdForge.git
cd CmdForge
pip install -e .
python -m pip install -e ".[mcp,pty]"
```
### With Development Dependencies
@@ -94,7 +104,7 @@ pip install -e ".[dev]"
### Requirements
- Python 3.10+
- At least one AI CLI tool installed (see [Provider Setup](docs/reference/providers.md))
- A configured provider for live AI calls; the built-in mock works without one
- PySide6 (included automatically - requires display server on Linux)
### Post-Install
@@ -195,7 +205,7 @@ cmdforge usage enable # Begin recording tool names in shell pipe
cmdforge usage suggestions # Show frequent pipelines
cmdforge usage clear # Delete all local usage history
# Model Context Protocol (optional: pip install -e ".[mcp]")
# Model Context Protocol (optional: python -m pip install "cmdforge[mcp]")
cmdforge mcp add local --command npx --arg=-y --arg @scope/server
cmdforge mcp add remote --transport streamable-http --url https://example.com/mcp
cmdforge mcp connect remote