Skip to main content

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:

Core Commands

ppm init

Initialize a new PPM project or convert existing project.
Arguments:
  • PROJECT_NAME - Name of the project (optional, uses current directory name)
Options: Examples:

ppm install

Install project dependencies from project.toml.
Arguments:
  • PACKAGES... - Specific packages to install (optional)
Options: Examples:

ppm add

Add new dependencies to your project.
Arguments:
  • PACKAGES... - Packages to add (required)
Options: Examples:

ppm remove

Remove dependencies from your project.
Arguments:
  • PACKAGES... - Packages to remove (required)
Options: Examples:

ppm run

Execute scripts defined in project.toml or run commands.
Arguments:
  • SCRIPT|COMMAND - Script name or command to run
  • ARGS... - Arguments to pass to the script/command
Options: Examples:

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.
Options: Examples:

ppm tree

Show dependency tree.
Arguments:
  • PACKAGE - Show tree for specific package (optional)
Options: Examples:

ppm outdated

Check for outdated dependencies.
Options:

ppm info

Show package information.
Arguments:
  • PACKAGE - Package name to show info for
Options:

Maintenance Commands

ppm update

Update dependencies to latest versions.
Arguments:
  • PACKAGES... - Specific packages to update (optional)
Options: Examples:

ppm audit

Audit dependencies for security vulnerabilities.
Options:

ppm clean

Clean package caches and temporary files.
Options:

Import/Export Commands

ppm import

Import from existing package files.
Arguments:
  • FILES... - Files to import from (package.json, requirements.txt, etc.)
Options: Examples:

ppm export

Export dependencies to other formats.
Arguments:
  • FORMAT - Export format (package.json, requirements.txt, etc.)
Options: Examples:

Configuration Commands

ppm config

Manage PPM configuration.

Subcommands:

get - Get configuration value
set - Set configuration value
unset - Remove configuration value
list - List all configuration
Examples:

Advanced Commands

ppm lock

Manage lock files.
Options:

ppm verify

Verify project integrity.
Options:

ppm doctor

Diagnose and fix common issues.
Options:

Exit Codes

PPM uses these exit codes:

Environment Variables

Control PPM behavior with environment variables:

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.