proxmox-community-script

Generate ProxmoxVE community scripts and JSON metadata conforming to submission requirements.

1|Updated Apr 18, 2010
One-click install
npx skills add https://github.com/morganp/dotfiles --skill proxmox-community-script
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: proxmox-community-script
Source: https://github.com/morganp/dotfiles/tree/main/config/claude/skills/proxmox-community-script
Command: npx skills add https://github.com/morganp/dotfiles --skill proxmox-community-script

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill guides contributors to produce ProxmoxVE community scripts that strictly follow the community-scripts conventions, preventing common formatting, packaging, and submission mistakes that lead to rejected pull requests.

Core Features & Use Cases

  • Structured Templates: Provides ct container script, install script, addon script, and JSON metadata patterns with required functions and layout.
  • Policy Enforcement: Enforces anti-pattern rules (no Docker, use fetch_and_deploy_gh_release, heredocs, $STD, correct service handling) and OS detection for Debian/Alpine.
  • Submission Workflow: Walks through testing in ProxmoxVED, creating minimal submission branches, and verifying PR contents to streamline successful upstream submissions.

Quick Start

Create a new ct or addon contribution by drafting the three required files (ct/install/json or tools/addon/json), follow the referenced patterns and anti-patterns, test in your ProxmoxVED fork, and then open a focused PR for review.

Frequently Asked Questions about proxmox-community-script

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I format a Proxmox LXC container script for community-scripts submission?

Generating Proxmox community scripts requires specific files: a ct container script, an install script, and frontend JSON metadata. You must also create an addon script and its corresponding JSON file if you are contributing a utility rather than a full application.

What anti-patterns cause ProxmoxVE community script pull requests to fail?

ProxmoxVE community script pull requests fail when using Docker, ignoring the fetch_and_deploy_gh_release helper, or mishandling services. Enforcing anti-pattern rules and using $STD with proper heredocs ensures your LXC container script meets submission requirements.

How do I test ProxmoxVE addon scripts before opening a PR?

To test ProxmoxVE addon scripts, draft the required files, apply the referenced patterns, and run them in your ProxmoxVED fork. Verifying that update_script handling and OS detection work correctly streamlines the process of opening a focused PR for review.

Can I use Docker when creating Proxmox LXC container scripts for ProxmoxVE?

No, Docker is explicitly prohibited as an anti-pattern when creating Proxmox LXC container scripts for ProxmoxVE. You must use fetch_and_deploy_gh_release, proper helper functions, and heredocs to ensure your application package meets community formatting rules.

What is the required JSON metadata format for ProxmoxVE community scripts?

The required JSON metadata format for ProxmoxVE community scripts serves as frontend configuration for LXC-based apps. Generating this metadata alongside your ct or addon script ensures your contribution includes the correct application details and passes validation checks.