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

# Installation

> Build and load Payment Sandbox Helper in Chrome or Firefox

## Installation options

Payment Sandbox Helper is currently documented as a source-built extension. Check the project's [GitHub Releases](https://github.com/ePlus-DEV/payment-sandbox-helper/releases) for packaged builds when available.

<Warning>
  Only install packages published by the official ePlus-DEV repository. Browser extensions can access pages covered by their declared content-script matches.
</Warning>

## Build from source

**Requirements:** a current Node.js LTS release, Corepack, and Yarn 4.

```bash theme={null}
# Clone the repository
git clone https://github.com/ePlus-DEV/payment-sandbox-helper.git
cd payment-sandbox-helper

# Enable the package manager declared by the project
corepack enable

# Install dependencies
yarn install

# Type-check the project
yarn compile

# Build Chrome
yarn build

# Optional: build Firefox
yarn build:firefox
```

## Load in Chrome

<Steps>
  <Step title="Build the extension">
    Run `yarn build`. WXT creates the Chrome Manifest V3 output under `.output/chrome-mv3`.
  </Step>

  <Step title="Open the extensions page">
    Visit `chrome://extensions` and enable **Developer mode**.
  </Step>

  <Step title="Load the output folder">
    Select **Load unpacked**, then choose `.output/chrome-mv3`.
  </Step>

  <Step title="Pin the extension">
    Pin Payment Sandbox Helper from the extensions menu so the sidebar is easy to open while testing.
  </Step>
</Steps>

## Load temporarily in Firefox

<Steps>
  <Step title="Build the Firefox package">
    Run `yarn build:firefox`.
  </Step>

  <Step title="Open Firefox debugging">
    Visit `about:debugging#/runtime/this-firefox` and select **Load Temporary Add-on**.
  </Step>

  <Step title="Select the manifest">
    Choose `manifest.json` from `.output/firefox-mv3`.
  </Step>
</Steps>

<Note>
  A temporary Firefox add-on is removed when Firefox restarts. Use a signed release package for normal long-term installation when one is published.
</Note>

## Package a distributable archive

```bash theme={null}
# Chrome archive
yarn zip

# Firefox archive
yarn zip:firefox
```

## Permissions

| Permission     | Purpose                                                              |
| -------------- | -------------------------------------------------------------------- |
| `activeTab`    | Work with the currently active sandbox or development page.          |
| `scripting`    | Support page interaction required by extension workflows.            |
| `sidePanel`    | Display the Chrome side panel.                                       |
| `contextMenus` | Add field-level fill actions to the right-click menu.                |
| `storage`      | Save country, cardholder name, backgrounds, and preferences locally. |

Firefox uses `sidebar_action` instead of Chrome's `sidePanel` API. The manifest declares no required data collection for the Firefox build.


## Related topics

- [FAQ](/payment-sandbox-helper/faq.md)
- [ePlus.DEV Browser Extensions](/index.md)