# PromptyDumpty
 [](https://pypi.org/project/prompty-dumpty/) [](https://pypi.org/project/prompty-dumpty/)
<img src="website/public/logo.png" width=200px />
A lightweight, universal package manager for AI agent artifacts (prompts, instructions, rules, workflows, etc.).
🌐 **Visit [dumpty.dev](https://dumpty.dev)** for full documentation and guides.
## What is it?
PromptyDumpty lets you install and manage prompt packages across different AI coding assistants like GitHub Copilot, Claude, Cursor, Gemini, Windsurf, and more.
## Why?
- **Share prompts easily**: Package and distribute your team's prompts
- **Works everywhere**: One package works with multiple AI agents
- **Simple**: Just YAML files and Git repos, no complex setup
- **Safe**: Clean installation and removal, clear tracking
## Quick Start
```bash
# Initialize in your project
dumpty init
# Install a package
dumpty install https://github.com/org/my-prompts
# List installed packages
dumpty list
# Update packages
dumpty update --all
# Remove a package
dumpty uninstall my-prompts
```
## How it works
1. **Auto-detects** your AI agent (checks for `.github/prompts/`, `.claude/commands/`, etc.)
2. **Installs** package files to the right directories
3. **Tracks** everything in a lockfile for easy management
4. **Organizes** files by package name for clean removal
## Package Structure
Organize your files however you want! The manifest defines everything:
```
my-package/
├── dumpty.package.yaml # Package manifest
├── README.md
└── src/ # Any structure you prefer
├── planning.md
├── review.md
└── standards.md
```
## Creating Packages
Define what your package provides in `dumpty.package.yaml` - organized by agent:
```yaml
name: my-workflows
version: 1.0.0
description: Custom development workflows
agents:
copilot:
artifacts:
- name: code-review
description: Code review workflow
file: src/review.md
installed_path: prompts/code-review.prompt.md
- name: standards
file: src/standards.md
installed_path: rules/standards.md
claude:
artifacts:
- name: code-review
file: src/review.md
installed_path: commands/review.md
```
**Key Features:**
- Organize files however makes sense to you
- Explicitly map each file to its install location per agent
- Reuse the same source file for multiple agents
- Full control over installed paths and filenames
## Documentation
📚 **Full documentation available at [dumpty.dev](https://dumpty.dev)**
- [Getting Started Guide](https://dumpty.dev/getting-started)
- [Creating Packages](https://dumpty.dev/creating-packages)
- [Full Documentation](https://dumpty.dev/docs)
## Installation
### From Source
```bash
# Clone the repository
git clone https://github.com/dasiths/PromptyDumpty.git
cd PromptyDumpty
# Install in development mode (recommended for contributors)
make install-dev
# Or install in production mode
make install
```
### Using pip (when published)
```bash
pip install prompty-dumpty
```
### Verify Installation
```bash
dumpty --version
```
## Development
### Prerequisites
- Python 3.8 or higher
- Git
- Make (optional, for using Makefile commands)
### Setup Development Environment
```bash
# Clone and navigate to repository
git clone https://github.com/dasiths/PromptyDumpty.git
cd PromptyDumpty
# Install in development mode with all dependencies
make install-dev
```
### Available Make Commands
**Python/CLI Commands:**
```bash
make help # Show all available commands
make test # Run tests
make test-cov # Run tests with coverage report
make lint # Run linters (ruff and black)
make format # Format code with black
make build # Build distribution packages
make clean # Remove build artifacts
make run ARGS='...' # Run dumpty CLI
```
**Website Commands:**
```bash
make website-install # Install website dependencies
make website-dev # Start dev server with hot reload
make website-build # Build website for production
make website-preview # Preview production build
make website-clean # Remove website build artifacts
```
### Running Tests
```bash
# Run all tests
make test
# Run tests with coverage
make test-cov
# Run specific test file
pytest tests/test_models.py -v
```
### Code Quality
```bash
# Check code formatting and linting
make lint
# Auto-format code
make format
```
## Usage Examples
### Initialize a Project
```bash
# Auto-detect agents in current directory
dumpty init
# Initialize with specific agent
dumpty init --agent copilot
dumpty init --agent claude
```
### Install Packages
```bash
# Install from GitHub repository
dumpty install https://github.com/org/my-prompts
# Install specific version tag
dumpty install https://github.com/org/my-prompts --version 1.0.0
# Install for specific agent
dumpty install https://github.com/org/my-prompts --agent copilot
```
### List Installed Packages
```bash
# Show installed packages (table view)
dumpty list
# Show detailed information
dumpty list --verbose
```
### Using the Makefile
```bash
# Run CLI commands using make
make run ARGS='--version'
make run ARGS='init --agent copilot'
make run ARGS='list'
make run ARGS='install https://github.com/org/my-prompts'
```
## Supported AI Agents
- **GitHub Copilot** (`.github/`)
- **Claude** (`.claude/`)
- **Cursor** (`.cursor/`)
- **Gemini** (`.gemini/`)
- **Windsurf** (`.windsurf/`)
- **Cline** (`.cline/`)
- **Aider** (`.aider/`)
- **Continue** (`.continue/`)
## Project Structure
```
PromptyDumpty/
├── dumpty/ # Main package
│ ├── cli.py # CLI entry point
│ ├── models.py # Data models
│ ├── agent_detector.py # Agent detection
│ ├── downloader.py # Package downloading
│ ├── installer.py # File installation
│ ├── lockfile.py # Lockfile management
│ └── utils.py # Utilities
├── tests/ # Test suite
├── website/ # Documentation website (dumpty.dev)
│ ├── src/ # React source files
│ ├── public/ # Static assets
│ └── README.md # Website development guide
├── docs/ # Documentation and planning
├── examples/ # Example packages and demos
├── pyproject.toml # Project configuration
├── Makefile # Build and development tasks
└── README.md # This file
```
## Website Development
The project website is built with Vite + React and deployed at [dumpty.dev](https://dumpty.dev).
### Running the Website Locally
```bash
# Install dependencies
make website-install
# Start dev server (with hot reload)
make website-dev
```
Visit `http://localhost:5173` in your browser.
### Building for Production
```bash
# Build the website
make website-build
# Preview production build
make website-preview
```
See [website/README.md](website/README.md) for more details and [website/DEPLOYMENT.md](website/DEPLOYMENT.md) for deployment instructions.
## Contributing
Contributions are welcome! Please:
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests: `make test`
5. Format code: `make format`
6. Check linting: `make lint`
7. Submit a pull request
## License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "prompty-dumpty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "ai, prompts, package-manager, copilot, claude, cursor",
"author": null,
"author_email": "Dasith Wijesiriwardena <git@dasith.me>",
"download_url": "https://files.pythonhosted.org/packages/d5/2f/459f1cbcec30d8e0a26a582b19c54b52ffca39c3169a7b0853073e602bae/prompty_dumpty-0.3.0.tar.gz",
"platform": null,
"description": "# PromptyDumpty \n [](https://pypi.org/project/prompty-dumpty/) [](https://pypi.org/project/prompty-dumpty/)\n\n<img src=\"website/public/logo.png\" width=200px />\n\nA lightweight, universal package manager for AI agent artifacts (prompts, instructions, rules, workflows, etc.).\n\n\ud83c\udf10 **Visit [dumpty.dev](https://dumpty.dev)** for full documentation and guides.\n\n## What is it?\n\nPromptyDumpty lets you install and manage prompt packages across different AI coding assistants like GitHub Copilot, Claude, Cursor, Gemini, Windsurf, and more.\n\n## Why?\n\n- **Share prompts easily**: Package and distribute your team's prompts\n- **Works everywhere**: One package works with multiple AI agents\n- **Simple**: Just YAML files and Git repos, no complex setup\n- **Safe**: Clean installation and removal, clear tracking\n\n## Quick Start\n\n```bash\n# Initialize in your project\ndumpty init\n\n# Install a package\ndumpty install https://github.com/org/my-prompts\n\n# List installed packages\ndumpty list\n\n# Update packages\ndumpty update --all\n\n# Remove a package\ndumpty uninstall my-prompts\n```\n\n## How it works\n\n1. **Auto-detects** your AI agent (checks for `.github/prompts/`, `.claude/commands/`, etc.)\n2. **Installs** package files to the right directories\n3. **Tracks** everything in a lockfile for easy management\n4. **Organizes** files by package name for clean removal\n\n## Package Structure\n\nOrganize your files however you want! The manifest defines everything:\n\n```\nmy-package/\n\u251c\u2500\u2500 dumpty.package.yaml # Package manifest\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 src/ # Any structure you prefer\n \u251c\u2500\u2500 planning.md\n \u251c\u2500\u2500 review.md\n \u2514\u2500\u2500 standards.md\n```\n\n## Creating Packages\n\nDefine what your package provides in `dumpty.package.yaml` - organized by agent:\n\n```yaml\nname: my-workflows\nversion: 1.0.0\ndescription: Custom development workflows\n\nagents:\n copilot:\n artifacts:\n - name: code-review\n description: Code review workflow\n file: src/review.md\n installed_path: prompts/code-review.prompt.md\n \n - name: standards\n file: src/standards.md\n installed_path: rules/standards.md\n \n claude:\n artifacts:\n - name: code-review\n file: src/review.md\n installed_path: commands/review.md\n```\n\n**Key Features:**\n- Organize files however makes sense to you\n- Explicitly map each file to its install location per agent\n- Reuse the same source file for multiple agents\n- Full control over installed paths and filenames\n\n## Documentation\n\n\ud83d\udcda **Full documentation available at [dumpty.dev](https://dumpty.dev)**\n\n- [Getting Started Guide](https://dumpty.dev/getting-started)\n- [Creating Packages](https://dumpty.dev/creating-packages)\n- [Full Documentation](https://dumpty.dev/docs)\n\n## Installation\n\n### From Source\n\n```bash\n# Clone the repository\ngit clone https://github.com/dasiths/PromptyDumpty.git\ncd PromptyDumpty\n\n# Install in development mode (recommended for contributors)\nmake install-dev\n\n# Or install in production mode\nmake install\n```\n\n### Using pip (when published)\n\n```bash\npip install prompty-dumpty\n```\n\n### Verify Installation\n\n```bash\ndumpty --version\n```\n\n## Development\n\n### Prerequisites\n\n- Python 3.8 or higher\n- Git\n- Make (optional, for using Makefile commands)\n\n### Setup Development Environment\n\n```bash\n# Clone and navigate to repository\ngit clone https://github.com/dasiths/PromptyDumpty.git\ncd PromptyDumpty\n\n# Install in development mode with all dependencies\nmake install-dev\n```\n\n### Available Make Commands\n\n**Python/CLI Commands:**\n```bash\nmake help # Show all available commands\nmake test # Run tests\nmake test-cov # Run tests with coverage report\nmake lint # Run linters (ruff and black)\nmake format # Format code with black\nmake build # Build distribution packages\nmake clean # Remove build artifacts\nmake run ARGS='...' # Run dumpty CLI\n```\n\n**Website Commands:**\n```bash\nmake website-install # Install website dependencies\nmake website-dev # Start dev server with hot reload\nmake website-build # Build website for production\nmake website-preview # Preview production build\nmake website-clean # Remove website build artifacts\n```\n\n### Running Tests\n\n```bash\n# Run all tests\nmake test\n\n# Run tests with coverage\nmake test-cov\n\n# Run specific test file\npytest tests/test_models.py -v\n```\n\n### Code Quality\n\n```bash\n# Check code formatting and linting\nmake lint\n\n# Auto-format code\nmake format\n```\n\n## Usage Examples\n\n### Initialize a Project\n\n```bash\n# Auto-detect agents in current directory\ndumpty init\n\n# Initialize with specific agent\ndumpty init --agent copilot\ndumpty init --agent claude\n```\n\n### Install Packages\n\n```bash\n# Install from GitHub repository\ndumpty install https://github.com/org/my-prompts\n\n# Install specific version tag\ndumpty install https://github.com/org/my-prompts --version 1.0.0\n\n# Install for specific agent\ndumpty install https://github.com/org/my-prompts --agent copilot\n```\n\n### List Installed Packages\n\n```bash\n# Show installed packages (table view)\ndumpty list\n\n# Show detailed information\ndumpty list --verbose\n```\n\n### Using the Makefile\n\n```bash\n# Run CLI commands using make\nmake run ARGS='--version'\nmake run ARGS='init --agent copilot'\nmake run ARGS='list'\nmake run ARGS='install https://github.com/org/my-prompts'\n```\n\n## Supported AI Agents\n\n- **GitHub Copilot** (`.github/`)\n- **Claude** (`.claude/`)\n- **Cursor** (`.cursor/`)\n- **Gemini** (`.gemini/`)\n- **Windsurf** (`.windsurf/`)\n- **Cline** (`.cline/`)\n- **Aider** (`.aider/`)\n- **Continue** (`.continue/`)\n\n## Project Structure\n\n```\nPromptyDumpty/\n\u251c\u2500\u2500 dumpty/ # Main package\n\u2502 \u251c\u2500\u2500 cli.py # CLI entry point\n\u2502 \u251c\u2500\u2500 models.py # Data models\n\u2502 \u251c\u2500\u2500 agent_detector.py # Agent detection\n\u2502 \u251c\u2500\u2500 downloader.py # Package downloading\n\u2502 \u251c\u2500\u2500 installer.py # File installation\n\u2502 \u251c\u2500\u2500 lockfile.py # Lockfile management\n\u2502 \u2514\u2500\u2500 utils.py # Utilities\n\u251c\u2500\u2500 tests/ # Test suite\n\u251c\u2500\u2500 website/ # Documentation website (dumpty.dev)\n\u2502 \u251c\u2500\u2500 src/ # React source files\n\u2502 \u251c\u2500\u2500 public/ # Static assets\n\u2502 \u2514\u2500\u2500 README.md # Website development guide\n\u251c\u2500\u2500 docs/ # Documentation and planning\n\u251c\u2500\u2500 examples/ # Example packages and demos\n\u251c\u2500\u2500 pyproject.toml # Project configuration\n\u251c\u2500\u2500 Makefile # Build and development tasks\n\u2514\u2500\u2500 README.md # This file\n```\n\n## Website Development\n\nThe project website is built with Vite + React and deployed at [dumpty.dev](https://dumpty.dev).\n\n### Running the Website Locally\n\n```bash\n# Install dependencies\nmake website-install\n\n# Start dev server (with hot reload)\nmake website-dev\n```\n\nVisit `http://localhost:5173` in your browser.\n\n### Building for Production\n\n```bash\n# Build the website\nmake website-build\n\n# Preview production build\nmake website-preview\n```\n\nSee [website/README.md](website/README.md) for more details and [website/DEPLOYMENT.md](website/DEPLOYMENT.md) for deployment instructions.\n\n## Contributing\n\nContributions are welcome! Please:\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Run tests: `make test`\n5. Format code: `make format`\n6. Check linting: `make lint`\n7. Submit a pull request\n\n## License\n\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Universal package manager for AI agent artifacts",
"version": "0.3.0",
"project_urls": {
"Documentation": "https://dumpty.dev/docs",
"Homepage": "https://dumpty.dev",
"Issues": "https://github.com/dasiths/PromptyDumpty/issues",
"Repository": "https://github.com/dasiths/PromptyDumpty"
},
"split_keywords": [
"ai",
" prompts",
" package-manager",
" copilot",
" claude",
" cursor"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fe982f8cb9136eae76aaa56e59f4f0f1ab3f09744a3f524fe86ef2a0084408fe",
"md5": "5f03ea649de0d9ae3dabbe7d887fc2fe",
"sha256": "91daf9f7d87d7289b7744b318fc8c5726c5c2d4f0ca7af09d3f13b9e391fa95b"
},
"downloads": -1,
"filename": "prompty_dumpty-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f03ea649de0d9ae3dabbe7d887fc2fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21663,
"upload_time": "2025-11-08T16:27:02",
"upload_time_iso_8601": "2025-11-08T16:27:02.448972Z",
"url": "https://files.pythonhosted.org/packages/fe/98/2f8cb9136eae76aaa56e59f4f0f1ab3f09744a3f524fe86ef2a0084408fe/prompty_dumpty-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d52f459f1cbcec30d8e0a26a582b19c54b52ffca39c3169a7b0853073e602bae",
"md5": "efaf7aed50ee4d246ce8782afaa505c4",
"sha256": "7271204ab6eea77ff66372bb5ab3bed955d241e4f205ef92562b47a1852631f0"
},
"downloads": -1,
"filename": "prompty_dumpty-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "efaf7aed50ee4d246ce8782afaa505c4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43505,
"upload_time": "2025-11-08T16:27:03",
"upload_time_iso_8601": "2025-11-08T16:27:03.932408Z",
"url": "https://files.pythonhosted.org/packages/d5/2f/459f1cbcec30d8e0a26a582b19c54b52ffca39c3169a7b0853073e602bae/prompty_dumpty-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-11-08 16:27:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dasiths",
"github_project": "PromptyDumpty",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "prompty-dumpty"
}
JSON
