Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PaoPao Logo

๐Ÿฅญ PaoPao's CLI Framework

A powerful, secure, and extensible Command Line Interface (CLI) framework designed to revolutionize your terminal workflow. Built with Python, it offers advanced plugin management, security features, and a rich user experience.

Python 3.6+ License: MIT


โšก Core Features

๐Ÿ› ๏ธ Built-in Commands

Command Description Enhanced Features
install Install community commands Security validation, branch selection, force overwrite
uninstall Remove commands Interactive confirmation, metadata cleanup
list Show installed commands Advanced filtering, sorting, detailed view
update Update commands from Git Change detection, force update option
info Show command details Complete metadata, dependency info
search Find commands Search by name, description, author
test Test local commands Security validation, timeout control
doctor System health check Comprehensive diagnostics, verbose mode
repl experiment featerimental feature, interactive shell Interactive Python shell for command development and testing

๐ŸŒ Community Integration

  • Git repository support (GitHub, GitLab, Bitbucket, Codeberg)
  • Automatic metadata extraction from project files
  • Dependency management and validation
  • Version tracking with installation history
  • Shallow cloning for faster installations

๐Ÿ”’ Security Features

  • URL scheme validation (prevents local file access)
  • Suspicious pattern detection in repositories
  • Code analysis for potentially dangerous imports
  • User confirmation for risky operations
  • File size limits (10MB max per file)

๐Ÿฅญ Installation

Quick Install

pip install paopao-cli

Development Install

git clone https://github.com/Paopun20/paopao-cli.git
cd paopao-cli
pip install -e .

Requirements

  • Python 3.6+
  • Git (for community commands)
  • Rich (for enhanced terminal output)
  • rich-argparse (for beautiful help pages)

๐Ÿš€ Quick Start

Basic Usage

# Show all available commands
ppc

# Get detailed help
ppc --help

# Check system health
ppc doctor

Installing Community Commands

# Install from GitHub
ppc install https://github.com/user/awesome-command

# Install specific branch
ppc install https://github.com/user/command --branch develop

# Install with custom name
ppc install https://github.com/user/tool --name mytool

# Force overwrite existing command
ppc install https://github.com/user/command --force

Managing Commands

# List all commands with details
ppc list --detailed

# List only community commands
ppc list --source community

# Sort by installation date
ppc list --sort installed --reverse

# Search for commands
ppc search "git"
ppc search "deploy" --source community

# Show detailed command info
ppc info my-command

# Update a command
ppc update my-command

# Uninstall with confirmation
ppc uninstall old-command

Development & Testing

# Test a local command script
ppc test --file my_script.py

# Test with security validation
ppc test --file script.py --validate --timeout 60

# Test with arguments
ppc test --file deploy.py -- --env production --dry-run

๐Ÿ“ Project Structure

paopao-cli/
โ”œโ”€โ”€ ppc_commands/          # Official commands
โ”œโ”€โ”€ ppc_addon/            # Community commands
โ”œโ”€โ”€ .ppc_cache/           # Cache and metadata
โ”œโ”€โ”€ docs/                 # Documentation
โ””โ”€โ”€ main.py              # Core framework

Command Structure

Addon Structure 0.0.1.1dev8+ (can add multiple commands per repository)

my-command/
โ”œโ”€โ”€ commands/
โ”‚   โ”œโ”€โ”€ command_name.py
โ”‚   โ”œโ”€โ”€ another_command.py
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ ppc.project.json     # Project metadata (legacy)
โ”œโ”€โ”€ ppc.project.toml     # Project metadata (0.0.1.dev10+)
โ”œโ”€โ”€ requirements.txt     # Dependencies (optional)
โ””โ”€โ”€ README.md           # Documentation (optional)

Legacy Structure (can add only one command per repository)

my-command/
โ”œโ”€โ”€ main.py              # Entry point (required)
โ”œโ”€โ”€ ppc.project.json     # Project metadata (legacy)
โ”œโ”€โ”€ ppc.project.toml     # Project metadata (0.0.1.dev10+)
โ”œโ”€โ”€ requirements.txt     # Dependencies (optional)
โ””โ”€โ”€ README.md           # Documentation (optional)

๐Ÿ”ง Advanced Configuration

Project Metadata (ppc.project.toml) (0.0.1.dev10+)

[project]
name = "plugin-name"
version = "0.1.0"
description = "Description plugin"
author = "Developer name"
python_version = ">=3.9"
dependencies = ["rich", "requests"]

Project Metadata (ppc.project.json) (legacy)

{
  "name": "plugin-name",
  "version": "0.1.0",
  "author": "Developer name",
  "description": "Description plugin",
  "python_version": ">=3.9",
  "dependencies": ["rich", "requests"],
  "keywords": ["automation", "productivity"],
  "homepage": "https://github.com/user/plugin-name"
}

๐Ÿ›ก๏ธ Security Guidelines

For Users

  • Review code before installing community commands
  • Use trusted sources (GitHub, GitLab, etc.)
  • Enable validation with --validate flag during testing
  • Regular updates keep commands secure

For Developers

  • Minimize dependencies in your commands
  • Avoid dangerous imports (subprocess, eval, etc.)
  • Include metadata in ppc.project.json
  • Document security implications in your README

๐Ÿ” Troubleshooting

Common Issues

Command not found after installation?

# Refresh command cache
ppc doctor
# Or force cache refresh
ppc list --detailed

Installation timeout?

# Increase timeout for large repositories
ppc install https://github.com/large/repo --no-shallow

Permission errors?

# Check directory permissions
ppc doctor --verbose

Git errors?

# Verify git installation
git --version # Should return git version if not installed, go to https://git-scm.com/downloads for installation
# or
pip show GitPython # Should return GitPython package info if not installed, run pip install GitPython

# Check network connectivity
ppc install https://github.com/test/repo

System Health Check

# Comprehensive system check
ppc doctor --verbose

# Check specific components
ppc doctor  # Basic check

๐Ÿค Contributing

Creating Commands

This is a simple template to create your own command compatible with PaoPao's CLI. AND THIS REPO IS OPEN SOURCE, YOU CAN CONTRIBUTE YOUR COMMANDS TO THE COMMUNITY! BUT UNDER APACHE LICENSE 2.0


๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


๐Ÿ’ฌ Support

Metadata

Release files for paopao-cli 0.0.1.dev10

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

Source distribution (sdist)

Source distribution for paopao-cli 0.0.1.dev10
File Size Uploaded Provenance Actions
paopao_cli-0.0.1.dev10.tar.gz 52.5 kB Without provenance Details for paopao_cli-0.0.1.dev10.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for paopao-cli 0.0.1.dev10
File Interpreter ABI Platform Actions
paopao_cli-0.0.1.dev10-py3-none-any.whl Python 3 none any Details for paopao_cli-0.0.1.dev10-py3-none-any.whl

Total release size: 107.6 kB

Release files / paopao_cli-0.0.1.dev10.tar.gz

Download URL paopao_cli-0.0.1.dev10.tar.gz
Size 52.5 kB
Tags Source
SHA-256 checksum
How to use checksums
925b99b65da3e1931802678be73f3015e5cef22b6d27cad815a7dd8b3cf72363
BLAKE2b-256 checksum
How to use checksums
40f4097061533f22dd06ee9e7cfe7b31368b6fb555d017f2a54992ed146ad127
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.13

Release files / paopao_cli-0.0.1.dev10-py3-none-any.whl

Download URL paopao_cli-0.0.1.dev10-py3-none-any.whl
Size 55.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bae4169a09f4afa375e9a707e3e206b4e39c4a3549633fe3984f2393fd153192
BLAKE2b-256 checksum
How to use checksums
d21ce62fb22c9e7bb00227ada8ad356a994a3af231eca1ab4c93d445aa821250
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.8.13

Security for paopao-cli 0.0.1.dev10

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