Blueprints

A blueprint is app-owned deployment metadata. It tells Reploy where app bundles come from, which options users can choose, what app commands exist, and how the Docker deployment should be shaped.

Blueprints can be referenced in three common ways.

Indexed Shorthand

reploy stage arbiter-server
reploy stage arbiter-server==0.9.3.dev1
reploy install arbiter-server

Shorthands are resolved through the Reploy blueprint index. The index entry is a single ref template. When it contains {version}, name==VERSION substitutes that version, while unpinned name substitutes latest.

PyPI Package

reploy stage pypi://example-app/example_app/reploy/example.blueprint.yaml
reploy stage pypi://example-app/example_app/reploy/example.blueprint.yaml?version=1.2.3
reploy install pypi://example-app/example_app/reploy/example.blueprint.yaml

Direct PyPI refs include the exact blueprint file path inside the package. Use the Reploy blueprint index when users should be able to type a short app name instead of the full package path.

Local File

reploy stage file:./path/to/app.blueprint.yaml
reploy install file:./path/to/app.blueprint.yaml

Local file refs are useful while developing an app blueprint before publishing it in a package or index.