How it Works
Define your web server startup commands just like Setup Commands. Instead of taking a snapshot, Codegen keeps the server running as a long-lived process. A “View Web Preview” button appears on the agent trace page once the server starts. Click it to open your running application in a new tab through Codegen’s secure proxy.
Access the Web Preview from the agent trace page
Configuration
You configure Web Preview commands in a manner similar to Setup Commands, likely within the same repository settings area (e.g.,https://codegen.com/{your_org}/{repo_name}/settings/web-preview
).
You’ll provide the command(s) necessary to start your development server. Ensure that your server is configured to listen on an appropriate host (often 127.0.0.1
) and a predictable port that Codegen can then expose.
The web server started for Web Preview MUST listen on port 3000. Codegen
is specifically configured to look for and expose applications running on this
port within the sandbox.
Common Examples
The primary use case is starting a development web server:The Web Preview server runs within the same sandbox environment as your other
agent tasks, meaning it has access to the same file system (including any
changes made by the agent) and the Environment
Variables.
The web preview is intended for development and debugging purposes. The server
is typically only accessible while the agent run is active or for a short
period afterward, and it’s not designed for public hosting.