Skip to content

Exporting Your App

When your app is ready to distribute, use the export command to package the entire project into a single .pgm archive file.

What is a .pgm File?

A .pgm file contains all the files from your project that are needed to run the app:

  • Project configuration (.ppro)
  • Workflow sequences (.pseq)
  • GUI interfaces (.pgui)
  • R and Python scripts
  • Asset files (images, fonts, data files, etc.)
  • Custom files listed in the project settings

Running the Export

Open the Command Palette (Ctrl+Shift+P) and run:

Apleno: Export app

A Save As dialog opens. Choose a destination path and filename (the .pgm extension is applied automatically). Click Save to start the export.

The extension:

  1. Walks the workspace folder recursively.
  2. Applies ignore rules (see below).
  3. Creates a file at the selected path.
  4. Saves the chosen export folder for next time.

Ignoring Files

You can exclude files and folders from the export using a .aplenoignore file in your workspace root. The syntax is the same as .gitignore:

# .aplenoignore

# Ignore development files
.vscode/
*.log
*.tmp

# Ignore test data
tests/
data/raw/

# Ignore large datasets
data/*.csv

Always excluded (built-in defaults):

  • .git/: Git history
  • .aplenoignore itself

What to Include

A well-structured export typically includes:

my-app.pgm
├── project.ppro
├── main.pseq
├── welcome.pgui
├── analysis.R
├── utils.R
├── processing.py
├── assets/
│   ├── logo.png
│   └── styles.css
└── .vscode/
    └── launch.json

Make sure all files referenced by your .ppro, .pseq, and .pgui files are present in the workspace. They will be included automatically unless explicitly excluded by .aplenoignore.

Tips

  • Run a final preview (Apleno: Run preview) before exporting to make sure the app works correctly.
  • Review the .aplenoignore to avoid accidentally including sensitive files (API keys, passwords, large test datasets).
  • The .pgm file can be opened by end users with the Apleno Client installed, or uploaded to a Apleno Server.
  • For version tracking, maintain the Changelog in the Project Editor so the version history is embedded in the exported app.