apm-cli


Nameapm-cli JSON
Version 0.5.1 PyPI version JSON
download
home_pageNone
SummaryMCP configuration tool
upload_time2025-11-08 23:30:54
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2025 Daniel Meppiel 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.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Agent Package Manager - npm for Agents

[![PyPI version](https://badge.fury.io/py/apm-cli.svg)](https://badge.fury.io/py/apm-cli)
[![CI/CD Pipeline](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml/badge.svg)](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml)
[![Downloads](https://img.shields.io/pypi/dm/apm-cli.svg)](https://pypi.org/project/apm-cli/)
[![GitHub stars](https://img.shields.io/github/stars/danielmeppiel/apm.svg?style=social&label=Star)](https://github.com/danielmeppiel/apm/stargazers)

**Stop copy-pasting prompts and instructions. Start packaging them.**

✅ Works with **GitHub Copilot, Cursor, Claude, Codex, Gemini and all [AGENTS.md](https://agents.md) adherents**  
✅ **2-minute setup** - zero config  
✅ **Team collaboration** - composable context, without wheel reinvention

## What Goes in Packages

📦 **Mix and match what your team needs**:

- **Agents** - Agentic workflows (.prompt.md files)
- **Context** - Company rules, standards, knowledge (.instructions.md files) and domain boundaries (.chatmode.md)

![APM Demo](docs/apm-demo.gif)

## Quick Start

> [!NOTE] 
> **📋 Prerequisites**: Get tokens at [github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new)  
> - **`GITHUB_COPILOT_PAT`** - User-scoped Fine-grained PAT with Copilot CLI subscription access 
> - **`GITHUB_APM_PAT`** - (optional) - Fine-grained PAT for access to private APM modules 
>
> 📖 **Complete Setup Guide**: [Getting Started](docs/getting-started.md)

### 30 Seconds: Zero-Config Prompt Execution

```bash
# Set up APM (one-time)
export GITHUB_COPILOT_PAT=your_token_here
curl -sSL "https://raw.githubusercontent.com/danielmeppiel/apm/main/install.sh" | sh

# 3. Set up GitHub Copilot CLI
apm runtime setup copilot

# Run any prompt from GitHub - zero config needed
apm run github/awesome-copilot/prompts/architecture-blueprint-generator
```

### 2 Minutes: Guardrailing with packaged context

```bash
# Create project with layered context from multiple APM packages
apm init my-project && cd my-project

# Install context + workflows from packages
apm install danielmeppiel/design-guidelines
apm install danielmeppiel/compliance-rules

# Compile into single AGENTS.md guardrails
# Now all agents respect design + compliance rules automatically
apm compile

# Run a prompt from the installed packages above
apm run design-review
```

**That's it!** Your project now has reliable AI workflows that work with any coding agent.

**GitHub Enterprise**: Works with GitHub Enterprise Server and Data Residency Cloud. [Configuration →](docs/getting-started.md#github-enterprise-support)

### Example `apm.yml` - Like package.json for AI Native projects

Here's what your `apm.yml` configuration file looks like (similar to `package.json` in npm):

```yaml
name: my-project
version: 1.0.0
description: My AI-native project
author: Developer

dependencies:
  apm:
    - danielmeppiel/compliance-rules
    - danielmeppiel/design-guidelines
    - github/awesome-copilot/prompts/architecture-blueprint-generator.prompt.md
  mcp:
    - github/github-mcp-server
    - microsoft/azure-devops-mcp

scripts:
  start: "copilot --full-auto -p hello-world.prompt.md"
```

> **Virtual Packages**: Install individual files directly from any repo (e.g., `apm install github/awesome-copilot/prompts/code-review.prompt.md`). [Learn more →](docs/getting-started.md#virtual-packages)

## What You Just Built

- **Agent Workflows** - Agent executable processes (.prompt.md files)
- **Context System** - Project knowledge that grounds AI responses
- **Dependency Management** - `apm_modules/` with shared context from other projects  
- **Universal Compatibility** - Works with any coding agent supporting the `Agents.md` standard (e.g. GitHub Copilot, Cursor, Claude, Codex, Gemini...)

## Mathematical Context Optimization

APM solves the AI agent context scalability problem through constraint satisfaction optimization.

**[Learn more about the Context Optimization Engine →](docs/compilation.md)**

## Key Commands

```bash
apm init <project>    # Initialize AI-native project
apm runtime setup     # Install coding agents (copilot recommended)
apm compile           # Generate AGENTS.md for compatibility  
apm install           # Install APM and MCP dependencies from apm.yml
apm deps list         # List installed APM dependencies
apm run <workflow>    # Execute Agent workflows
```

## Installation Options

### Homebrew
```bash
brew tap danielmeppiel/apm-cli
brew install apm-cli
```

### Python Package
```bash
pip install apm-cli
```

[See complete installation guide](docs/getting-started.md) for all options and troubleshooting.

## Demo Example

**APM Packages** (reusable modules):
- 🏢 [`compliance-rules`](https://github.com/danielmeppiel/compliance-rules) - GDPR contexts + audit workflows  
- 👤 [`design-guidelines`](https://github.com/danielmeppiel/design-guidelines) - Accessibility rules + UI review workflows

**Application using APM**:
- 🚀 **[Corporate Website](https://github.com/danielmeppiel/corporate-website)** - Complete showcase demonstrating Context Optimization Engine + both packages above as dependencies

## 🌟 APM Packages
*Copy this badge for your APM packages* 

[![Install with APM](https://img.shields.io/badge/📦_Install_with-APM-blue?style=flat-square)](https://github.com/danielmeppiel/apm#-apm-packages) 

Install any of the below APM packages with: `apm install <owner>/<repo>`

- [DevExpGbb/platform-mode](https://github.com/DevExpGbb/platform-mode) - The Future of AI-Enhanced Platform Engineering
- [Add yours here!](https://github.com/danielmeppiel/apm/discussions/new)

## Next Steps

- 📖 [Complete Documentation](docs/README.md) - Deep dive into APM
- 🚀 [Getting Started Guide](docs/getting-started.md) - Extended setup and first project
- 🧠 [Core Concepts](docs/concepts.md) - AI-Native Development framework  
- 📦 [Examples & Use Cases](docs/examples.md) - Real-world workflow patterns
- 🔧 [Agent Primitives Guide](docs/primitives.md) - Build advanced workflows
- 🤝 [Contributing](CONTRIBUTING.md) - Join the AI-native ecosystem

---

**Learning Guide — Awesome AI Native**  
A practical companion guide that inspired APM CLI: <https://danielmeppiel.github.io/awesome-ai-native>

A friendly, step by step example-driven learning path for AI-Native Development — leveraging APM CLI along the way.

---

**APM transforms any project into reliable AI-Native Development**

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "apm-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Daniel Meppiel <user@example.com>",
    "download_url": "https://files.pythonhosted.org/packages/19/45/d27b5d5cc405003b2fcc82d6b58ec665c8339cc8a0433d757086ddffda13/apm_cli-0.5.1.tar.gz",
    "platform": null,
    "description": "# Agent Package Manager - npm for Agents\n\n[![PyPI version](https://badge.fury.io/py/apm-cli.svg)](https://badge.fury.io/py/apm-cli)\n[![CI/CD Pipeline](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml/badge.svg)](https://github.com/danielmeppiel/apm/actions/workflows/build-release.yml)\n[![Downloads](https://img.shields.io/pypi/dm/apm-cli.svg)](https://pypi.org/project/apm-cli/)\n[![GitHub stars](https://img.shields.io/github/stars/danielmeppiel/apm.svg?style=social&label=Star)](https://github.com/danielmeppiel/apm/stargazers)\n\n**Stop copy-pasting prompts and instructions. Start packaging them.**\n\n\u2705 Works with **GitHub Copilot, Cursor, Claude, Codex, Gemini and all [AGENTS.md](https://agents.md) adherents**  \n\u2705 **2-minute setup** - zero config  \n\u2705 **Team collaboration** - composable context, without wheel reinvention\n\n## What Goes in Packages\n\n\ud83d\udce6 **Mix and match what your team needs**:\n\n- **Agents** - Agentic workflows (.prompt.md files)\n- **Context** - Company rules, standards, knowledge (.instructions.md files) and domain boundaries (.chatmode.md)\n\n![APM Demo](docs/apm-demo.gif)\n\n## Quick Start\n\n> [!NOTE] \n> **\ud83d\udccb Prerequisites**: Get tokens at [github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new)  \n> - **`GITHUB_COPILOT_PAT`** - User-scoped Fine-grained PAT with Copilot CLI subscription access \n> - **`GITHUB_APM_PAT`** - (optional) - Fine-grained PAT for access to private APM modules \n>\n> \ud83d\udcd6 **Complete Setup Guide**: [Getting Started](docs/getting-started.md)\n\n### 30 Seconds: Zero-Config Prompt Execution\n\n```bash\n# Set up APM (one-time)\nexport GITHUB_COPILOT_PAT=your_token_here\ncurl -sSL \"https://raw.githubusercontent.com/danielmeppiel/apm/main/install.sh\" | sh\n\n# 3. Set up GitHub Copilot CLI\napm runtime setup copilot\n\n# Run any prompt from GitHub - zero config needed\napm run github/awesome-copilot/prompts/architecture-blueprint-generator\n```\n\n### 2 Minutes: Guardrailing with packaged context\n\n```bash\n# Create project with layered context from multiple APM packages\napm init my-project && cd my-project\n\n# Install context + workflows from packages\napm install danielmeppiel/design-guidelines\napm install danielmeppiel/compliance-rules\n\n# Compile into single AGENTS.md guardrails\n# Now all agents respect design + compliance rules automatically\napm compile\n\n# Run a prompt from the installed packages above\napm run design-review\n```\n\n**That's it!** Your project now has reliable AI workflows that work with any coding agent.\n\n**GitHub Enterprise**: Works with GitHub Enterprise Server and Data Residency Cloud. [Configuration \u2192](docs/getting-started.md#github-enterprise-support)\n\n### Example `apm.yml` - Like package.json for AI Native projects\n\nHere's what your `apm.yml` configuration file looks like (similar to `package.json` in npm):\n\n```yaml\nname: my-project\nversion: 1.0.0\ndescription: My AI-native project\nauthor: Developer\n\ndependencies:\n  apm:\n    - danielmeppiel/compliance-rules\n    - danielmeppiel/design-guidelines\n    - github/awesome-copilot/prompts/architecture-blueprint-generator.prompt.md\n  mcp:\n    - github/github-mcp-server\n    - microsoft/azure-devops-mcp\n\nscripts:\n  start: \"copilot --full-auto -p hello-world.prompt.md\"\n```\n\n> **Virtual Packages**: Install individual files directly from any repo (e.g., `apm install github/awesome-copilot/prompts/code-review.prompt.md`). [Learn more \u2192](docs/getting-started.md#virtual-packages)\n\n## What You Just Built\n\n- **Agent Workflows** - Agent executable processes (.prompt.md files)\n- **Context System** - Project knowledge that grounds AI responses\n- **Dependency Management** - `apm_modules/` with shared context from other projects  \n- **Universal Compatibility** - Works with any coding agent supporting the `Agents.md` standard (e.g. GitHub Copilot, Cursor, Claude, Codex, Gemini...)\n\n## Mathematical Context Optimization\n\nAPM solves the AI agent context scalability problem through constraint satisfaction optimization.\n\n**[Learn more about the Context Optimization Engine \u2192](docs/compilation.md)**\n\n## Key Commands\n\n```bash\napm init <project>    # Initialize AI-native project\napm runtime setup     # Install coding agents (copilot recommended)\napm compile           # Generate AGENTS.md for compatibility  \napm install           # Install APM and MCP dependencies from apm.yml\napm deps list         # List installed APM dependencies\napm run <workflow>    # Execute Agent workflows\n```\n\n## Installation Options\n\n### Homebrew\n```bash\nbrew tap danielmeppiel/apm-cli\nbrew install apm-cli\n```\n\n### Python Package\n```bash\npip install apm-cli\n```\n\n[See complete installation guide](docs/getting-started.md) for all options and troubleshooting.\n\n## Demo Example\n\n**APM Packages** (reusable modules):\n- \ud83c\udfe2 [`compliance-rules`](https://github.com/danielmeppiel/compliance-rules) - GDPR contexts + audit workflows  \n- \ud83d\udc64 [`design-guidelines`](https://github.com/danielmeppiel/design-guidelines) - Accessibility rules + UI review workflows\n\n**Application using APM**:\n- \ud83d\ude80 **[Corporate Website](https://github.com/danielmeppiel/corporate-website)** - Complete showcase demonstrating Context Optimization Engine + both packages above as dependencies\n\n## \ud83c\udf1f APM Packages\n*Copy this badge for your APM packages* \n\n[![Install with APM](https://img.shields.io/badge/\ud83d\udce6_Install_with-APM-blue?style=flat-square)](https://github.com/danielmeppiel/apm#-apm-packages) \n\nInstall any of the below APM packages with: `apm install <owner>/<repo>`\n\n- [DevExpGbb/platform-mode](https://github.com/DevExpGbb/platform-mode) - The Future of AI-Enhanced Platform Engineering\n- [Add yours here!](https://github.com/danielmeppiel/apm/discussions/new)\n\n## Next Steps\n\n- \ud83d\udcd6 [Complete Documentation](docs/README.md) - Deep dive into APM\n- \ud83d\ude80 [Getting Started Guide](docs/getting-started.md) - Extended setup and first project\n- \ud83e\udde0 [Core Concepts](docs/concepts.md) - AI-Native Development framework  \n- \ud83d\udce6 [Examples & Use Cases](docs/examples.md) - Real-world workflow patterns\n- \ud83d\udd27 [Agent Primitives Guide](docs/primitives.md) - Build advanced workflows\n- \ud83e\udd1d [Contributing](CONTRIBUTING.md) - Join the AI-native ecosystem\n\n---\n\n**Learning Guide \u2014 Awesome AI Native**  \nA practical companion guide that inspired APM CLI: <https://danielmeppiel.github.io/awesome-ai-native>\n\nA friendly, step by step example-driven learning path for AI-Native Development \u2014 leveraging APM CLI along the way.\n\n---\n\n**APM transforms any project into reliable AI-Native Development**\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Daniel Meppiel\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "MCP configuration tool",
    "version": "0.5.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c19661dbf46ef10b6516661e795774bd22ae81c58bfd410d5ed942142e4521e3",
                "md5": "402865cf8a2287f8a79919502cb93855",
                "sha256": "ab9d7f428fff48bccac4d59bf6a569f92b87955dfc2c4ab5d6c16d5c5b959d5c"
            },
            "downloads": -1,
            "filename": "apm_cli-0.5.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "402865cf8a2287f8a79919502cb93855",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 184671,
            "upload_time": "2025-11-08T23:30:52",
            "upload_time_iso_8601": "2025-11-08T23:30:52.945358Z",
            "url": "https://files.pythonhosted.org/packages/c1/96/61dbf46ef10b6516661e795774bd22ae81c58bfd410d5ed942142e4521e3/apm_cli-0.5.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1945d27b5d5cc405003b2fcc82d6b58ec665c8339cc8a0433d757086ddffda13",
                "md5": "9a42a77b4e529957d2fffe35a83c4f55",
                "sha256": "8913b7e9e73002e2751e43656796208efd1889957139daa0716c3806c18e38b6"
            },
            "downloads": -1,
            "filename": "apm_cli-0.5.1.tar.gz",
            "has_sig": false,
            "md5_digest": "9a42a77b4e529957d2fffe35a83c4f55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 183849,
            "upload_time": "2025-11-08T23:30:54",
            "upload_time_iso_8601": "2025-11-08T23:30:54.958497Z",
            "url": "https://files.pythonhosted.org/packages/19/45/d27b5d5cc405003b2fcc82d6b58ec665c8339cc8a0433d757086ddffda13/apm_cli-0.5.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-11-08 23:30:54",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "apm-cli"
}
        
Elapsed time: 0.65419s