> ## Documentation Index
> Fetch the complete documentation index at: https://kaiser.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Get PPM installed on your system quickly and easily

# Installation

PPM provides multiple installation methods to suit different preferences and environments. Choose the method that works best for your setup.

## Quick Install (Recommended)

The fastest way to get PPM running on your system:

<Tabs>
  <Tab title="Windows">
    Open PowerShell as Administrator and run:

    ```powershell theme={null}
    Invoke-WebRequest https://raw.githubusercontent.com/VesperAkshay/polypm/main/install.ps1 -UseBasicParsing | Invoke-Expression
    ```

    This will:

    * Download the latest PPM binary
    * Install it to your system PATH
    * Verify the installation
  </Tab>

  <Tab title="macOS/Linux">
    Open Terminal and run:

    ```bash theme={null}
    curl -fsSL https://raw.githubusercontent.com/VesperAkshay/polypm/main/install.sh | bash
    ```

    This will:

    * Download the latest PPM binary for your architecture
    * Install it to `/usr/local/bin`
    * Make it executable and verify installation
  </Tab>
</Tabs>

<Note>
  The installer scripts automatically detect your operating system and architecture, downloading the appropriate binary for your system.
</Note>

## Manual Installation

If you prefer to install PPM manually or the quick install doesn't work for your setup:

### Download Pre-built Binaries

Download the latest release for your platform from GitHub:

<CardGroup cols={3}>
  <Card title="Windows x64" icon="windows" href="https://github.com/VesperAkshay/polypm/releases/latest/download/ppm-windows-x86_64.exe">
    `.exe` file for Windows 64-bit
  </Card>

  <Card title="Linux x64" icon="linux" href="https://github.com/VesperAkshay/polypm/releases/latest/download/ppm-linux-x86_64">
    Binary for Linux 64-bit
  </Card>

  <Card title="macOS Universal" icon="apple" href="https://github.com/VesperAkshay/polypm/releases/latest/download/ppm-macos-universal">
    Universal binary for Intel and Apple Silicon
  </Card>
</CardGroup>

### Installation Steps

<Steps>
  <Step title="Download the Binary">
    Download the appropriate binary for your operating system from the links above.
  </Step>

  <Step title="Make it Executable (macOS/Linux)">
    ```bash theme={null}
    chmod +x ppm-*
    ```
  </Step>

  <Step title="Move to System PATH">
    **macOS/Linux:**

    ```bash theme={null}
    sudo mv ppm-* /usr/local/bin/ppm
    ```

    **Windows:**

    * Rename the file to `ppm.exe`
    * Move it to a directory in your PATH (e.g., `C:\Program Files\PPM\`)
    * Add that directory to your system PATH if needed
  </Step>

  <Step title="Verify Installation">
    ```bash theme={null}
    ppm --version
    ```
  </Step>
</Steps>

## Build from Source

For developers who want to build PPM from source or contribute to the project:

### Prerequisites

* [Rust](https://rustup.rs/) 1.75 or later
* Git

### Build Steps

<Steps>
  <Step title="Clone the Repository">
    ```bash theme={null}
    git clone https://github.com/VesperAkshay/polypm.git
    cd polypm
    ```
  </Step>

  <Step title="Build the Project">
    ```bash theme={null}
    cargo build --release
    ```
  </Step>

  <Step title="Install Locally">
    ```bash theme={null}
    cargo install --path .
    ```

    This installs PPM to your Cargo bin directory (usually `~/.cargo/bin/`).
  </Step>

  <Step title="Verify Installation">
    ```bash theme={null}
    ppm --version
    ```
  </Step>
</Steps>

## Package Managers

PPM will be available through popular package managers soon:

<Tabs>
  <Tab title="Homebrew (macOS/Linux)">
    ```bash theme={null}
    # Coming soon
    brew install ppm
    ```

    <Note>Homebrew formula is in development</Note>
  </Tab>

  <Tab title="Chocolatey (Windows)">
    ```powershell theme={null}
    # Coming soon
    choco install ppm
    ```

    <Note>Chocolatey package is in development</Note>
  </Tab>

  <Tab title="Snap (Linux)">
    ```bash theme={null}
    # Coming soon
    sudo snap install ppm
    ```

    <Note>Snap package is in development</Note>
  </Tab>
</Tabs>

## System Requirements

PPM has minimal system requirements:

| Platform    | Minimum Requirements                       |
| ----------- | ------------------------------------------ |
| **Windows** | Windows 10 or later (x64)                  |
| **macOS**   | macOS 10.15 or later (Intel/Apple Silicon) |
| **Linux**   | Any modern distribution (x64)              |

### Required Dependencies

PPM manages JavaScript and Python projects, so you'll need:

* **Node.js** (version 14 or later) - for JavaScript projects
* **Python** (version 3.8 or later) - for Python projects

<Warning>
  PPM can work with projects that only use one language, but its real power comes from managing polyglot projects that use both JavaScript and Python.
</Warning>

## Verification

After installation, verify that PPM is working correctly:

```bash theme={null}
# Check version
ppm --version

# Check available commands
ppm --help

# Test with a simple project
ppm init test-project
cd test-project
ppm install
```

## Troubleshooting

### Common Issues

<AccordionGroup>
  <Accordion title="Command not found: ppm">
    **Solution:** The PPM binary is not in your system PATH.

    * **Windows:** Add the PPM installation directory to your PATH environment variable
    * **macOS/Linux:** Make sure `/usr/local/bin` is in your PATH, or move PPM to a directory that is
  </Accordion>

  <Accordion title="Permission denied (macOS/Linux)">
    **Solution:** The binary doesn't have execute permissions.

    ```bash theme={null}
    chmod +x /usr/local/bin/ppm
    ```
  </Accordion>

  <Accordion title="Windows SmartScreen warning">
    **Solution:** Windows may show a security warning for unsigned binaries.

    * Click "More info" then "Run anyway"
    * This is normal for open-source software without expensive code signing certificates
  </Accordion>

  <Accordion title="SSL/TLS errors during download">
    **Solution:** Your system's certificates might be outdated.

    * Update your system
    * Try downloading manually from the GitHub releases page
  </Accordion>
</AccordionGroup>

### Getting Help

If you encounter issues not covered here:

1. Check the [GitHub Issues](https://github.com/VesperAkshay/polypm/issues) for known problems
2. Search [GitHub Discussions](https://github.com/VesperAkshay/polypm/discussions) for community help
3. Create a new issue with details about your system and the error

## Uninstallation

To uninstall PPM from your system:

<Tabs>
  <Tab title="Windows">
    ```powershell theme={null}
    Invoke-WebRequest https://raw.githubusercontent.com/VesperAkshay/polypm/main/uninstall.ps1 -UseBasicParsing | Invoke-Expression
    ```
  </Tab>

  <Tab title="macOS/Linux">
    ```bash theme={null}
    curl -fsSL https://raw.githubusercontent.com/VesperAkshay/polypm/main/uninstall.sh | bash
    ```
  </Tab>

  <Tab title="Manual">
    Simply delete the PPM binary:

    ```bash theme={null}
    # macOS/Linux
    sudo rm /usr/local/bin/ppm

    # Windows (PowerShell)
    Remove-Item "C:\Program Files\PPM\ppm.exe"
    ```
  </Tab>
</Tabs>

***

Ready to get started? Head to the [Quick Start Guide](/quickstart) to build your first polyglot project!