CLI Commands
PPM provides a comprehensive command-line interface for managing polyglot projects. This reference covers all available commands, their options, and usage examples.Global Options
These options are available for all PPM commands:Option | Short | Description |
---|---|---|
--help | -h | Show help information |
--version | -V | Show PPM version |
--verbose | -v | Enable verbose output |
--quiet | -q | Suppress non-error output |
--config <path> | -c | Use custom config file |
--no-color | Disable colored output |
Core Commands
ppm init
Initialize a new PPM project or convert existing project.
PROJECT_NAME
- Name of the project (optional, uses current directory name)
Option | Description |
---|---|
--force | Overwrite existing project.toml |
--template <name> | Use project template |
--js-manager <manager> | JavaScript package manager (npm, yarn, pnpm) |
--python <version> | Python version to use |
--venv-dir <path> | Virtual environment directory |
--no-js | Skip JavaScript setup |
--no-python | Skip Python setup |
--interactive | Interactive project setup |
ppm install
Install project dependencies from project.toml.
PACKAGES...
- Specific packages to install (optional)
Option | Description |
---|---|
--frozen | Install exact versions from lock file |
--no-lockfile | Don’t generate/update lock file |
--dev | Install development dependencies |
--prod | Install only production dependencies |
--env <environment> | Use specific environment |
--force | Force reinstall all packages |
--offline | Don’t access network (use cache only) |
ppm add
Add new dependencies to your project.
PACKAGES...
- Packages to add (required)
Option | Description |
---|---|
--dev | Add as development dependency |
--optional | Add as optional dependency |
--js | Force add as JavaScript package |
--python | Force add as Python package |
--version <spec> | Specific version constraint |
--no-install | Add to config without installing |
ppm remove
Remove dependencies from your project.
PACKAGES...
- Packages to remove (required)
Option | Description |
---|---|
--dev | Remove from development dependencies |
--js | Force remove as JavaScript package |
--python | Force remove as Python package |
--no-uninstall | Remove from config without uninstalling |
ppm run
Execute scripts defined in project.toml or run commands.
SCRIPT|COMMAND
- Script name or command to runARGS...
- Arguments to pass to the script/command
Option | Description |
---|---|
--env <environment> | Use specific environment |
--parallel | Run multiple scripts in parallel |
--silent | Suppress script output |
Virtual Environment Commands
ppm venv
Manage Python virtual environments.
Subcommands:
create
- Create virtual environment
activate
- Show activation command
info
- Show environment information
list
- List all environments
remove
- Remove virtual environment
clean
- Clean environment packages
rebuild
- Rebuild virtual environment
Information Commands
ppm list
List installed packages.
Option | Description |
---|---|
--js | Show only JavaScript packages |
--python | Show only Python packages |
--dev | Include development dependencies |
--outdated | Show only outdated packages |
--format <format> | Output format (table, json, csv) |
ppm tree
Show dependency tree.
PACKAGE
- Show tree for specific package (optional)
Option | Description |
---|---|
--js | Show only JavaScript dependencies |
--python | Show only Python dependencies |
--depth <n> | Maximum depth to show |
--reverse | Show reverse dependencies |
ppm outdated
Check for outdated dependencies.
Option | Description |
---|---|
--js | Check only JavaScript packages |
--python | Check only Python packages |
--format <format> | Output format (table, json) |
ppm info
Show package information.
PACKAGE
- Package name to show info for
Option | Description |
---|---|
--js | Look up JavaScript package |
--python | Look up Python package |
--versions | Show available versions |
Maintenance Commands
ppm update
Update dependencies to latest versions.
PACKAGES...
- Specific packages to update (optional)
Option | Description |
---|---|
--js | Update only JavaScript packages |
--python | Update only Python packages |
--dev | Include development dependencies |
--latest | Update to latest versions (ignore constraints) |
--dry-run | Show what would be updated |
ppm audit
Audit dependencies for security vulnerabilities.
Option | Description |
---|---|
--js | Audit only JavaScript packages |
--python | Audit only Python packages |
--fix | Automatically fix vulnerabilities |
--severity <level> | Filter by severity (low, moderate, high, critical) |
ppm clean
Clean package caches and temporary files.
Option | Description |
---|---|
--cache | Clean package manager caches |
--deps | Clean installed dependencies |
--all | Clean everything |
--force | Don’t ask for confirmation |
Import/Export Commands
ppm import
Import from existing package files.
FILES...
- Files to import from (package.json, requirements.txt, etc.)
Option | Description |
---|---|
--from <file> | Import from specific file |
--merge | Merge with existing project.toml |
--dev | Import as development dependencies |
ppm export
Export dependencies to other formats.
FORMAT
- Export format (package.json, requirements.txt, etc.)
Option | Description |
---|---|
--output <file> | Output file path |
--dev | Include development dependencies |
--frozen | Export exact versions |
Configuration Commands
ppm config
Manage PPM configuration.
Subcommands:
get
- Get configuration value
set
- Set configuration value
unset
- Remove configuration value
list
- List all configuration
Advanced Commands
ppm lock
Manage lock files.
Option | Description |
---|---|
--update | Update lock file without installing |
--check | Verify lock file is up to date |
ppm verify
Verify project integrity.
Option | Description |
---|---|
--lockfile | Verify against lock file |
--config | Verify configuration |
ppm doctor
Diagnose and fix common issues.
Option | Description |
---|---|
--fix | Automatically fix issues |
--verbose | Show detailed diagnostics |
Exit Codes
PPM uses these exit codes:Code | Meaning |
---|---|
0 | Success |
1 | General error |
2 | Command not found |
3 | Configuration error |
4 | Network error |
5 | Permission error |
6 | Package not found |
7 | Version conflict |
Environment Variables
Control PPM behavior with environment variables:Variable | Description |
---|---|
PPM_CONFIG_FILE | Custom config file path |
PPM_CACHE_DIR | Custom cache directory |
PPM_PYTHON_VERSION | Default Python version |
PPM_NO_COLOR | Disable colored output |
PPM_VERBOSE | Enable verbose output |
Shell Completion
Enable shell completion for better CLI experience:This reference covers all PPM CLI commands and options. For specific examples and use cases, see the Quickstart Guide and Examples.