Build Output API (v3)
The Build Output API is a file-system-based specification for a directory structure that can produce a Epycbyte deployment. Framework authors can leverage this directory structure as the output of their build command to utilize all Epycbyte platform features.
Overview
The Build Output API closely maps to Epycbyte product features in a logical and understandable format. It is primarily targeted toward framework authors who want to integrate with Epycbyte's capabilities, such as Serverless Functions, Edge Functions, Routing, and Caching.
If you are a framework author, you can use this reference to understand which files your framework should emit to the .epycbyte/output directory. If you are not using a framework but still want to utilize its features, you can manually create the .epycbyte/output directory and populate it according to this specification.
Known Limitations
- Native Dependencies: When building locally, native dependencies will compile for your machine's architecture, which may differ from production on Epycbyte. For projects relying on native binaries, build on a Linux machine with an x64 CPU.
- Deprecated Versions: v1 and v2 of the Build Output API are deprecated and should not be used for new projects.
Next Steps
- Configuration: Learn about the Build Output Configuration file to customize deployment behavior.
- Epycbyte Primitives: Understand how Epycbyte primitives work together to create a deployment.
- Features: Implement common Epycbyte platform features through the Build Output API.
Last updated on September 10, 2024