https://github.com/coder/preview

Template preview engine
https://github.com/coder/preview

Last synced: 7 months ago
JSON representation

Template preview engine

• Host: GitHub
• URL: https://github.com/coder/preview
• Owner: coder
• License: agpl-3.0
• Created: 2025-01-28T01:59:39.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-06-11T22:27:31.000Z (7 months ago)
• Last Synced: 2025-06-11T23:34:38.160Z (7 months ago)
• Language: Go
• Size: 1.3 MB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          



  

    

  

  

    

  




  Workspace Parameters sourced from Terraform









[Coder Repo](https://github.com/coder/coder) |

[Docs](https://coder.com/docs) |

[Why Coder](https://coder.com/why) |

[Premium](https://coder.com/pricing#compare-plans)

[![discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder)

[![release](https://img.shields.io/github/v/release/coder/preview)](https://github.com/coder/preview/releases/latest)

[![godoc](https://pkg.go.dev/badge/github.com/coder/preview.svg)](https://pkg.go.dev/github.com/coder/preview)

[![Go Report Card](https://goreportcard.com/badge/github.com/coder/preview)](https://goreportcard.com/report/github.com/coder/preview)

[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/9511/badge)](https://www.bestpractices.dev/projects/9511)

[![license](https://img.shields.io/github/license/coder/preview)](./LICENSE)



This repository contains a component of Coder, currently called Preview, that extracts and manages

[workspace parameters](https://coder.com/docs/admin/templates/extending-templates/parameters)

from Terraform configurations.

It provides real-time validation to verify user selections and compatibility while presenting dynamic form controls that

adapt based on previous choices.

As users select parameters from the template, Preview validates the selection for compatibility and user entitlements.

The form updates other fields based on the selections and only shows relevant and compatible options.

Once Preview is incorporated in Coder, it will allow template admins to use a variety of form controls with dependencies

from which users can deploy their ideal workspaces.



  



## Support

Do you have a workspace template that has incorrect parameters? Please open

[workspace template behavior issue](https://github.com/coder/preview/issues/new?template=workspace-template-bug-report.md).

For other bugs, feature requests, etc, feel free to

[open an issue](https://github.com/coder/preview/issues/new).

[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress

features and chat with the community using Coder!