You can try the latest version of the editor online.
- Go to the Deployments page of this repository.
- Click on the latest "Preview" or "Production" deployment and click the provided URL to launch the app.
To enable the application to fetch the list of available TRB versions from the official repository, you must configure a GitHub Token. This is required to access the GitHub API without hitting strict rate limits.
Set the following environment variable in your .env file (for local development) or your deployment platform's configuration settings:
| Variable | Description | Required |
|---|---|---|
APP_GITHUB_TOKEN |
A GitHub Personal Access Token (classic or fine-grained) with public_repo scope (or read-only access to public repositories). |
Yes |
Provides convenient URL-based access to blueprints hosted in GitHub repositories. This enables quick sharing, embedding in documentation, and seamless integration with existing workflows.
Opens the blueprint in interactive read-only mode for safe viewing and exploration, supports node interceptor-based desensitization for public-safe viewing, such as masking internal names, removing sensitive metadata, and replacing confidential labels with public aliases.
Access blueprints directly from any GitHub repository using the ?github= parameter:
https://your-deployment.vercel.app/?github=owner/repo
To make your TRB project repository compatible with TRB Painter, see the TRB Template for a complete example with best practices, and to recognize what a node interceptor is.
Offers two methods for generating PNG images of your blueprint:
| Route | /?github=&view=png |
/api/render?github= |
|---|---|---|
| Returns | HTML page with image preview | Direct image file |
Embedded in <img> or Markdown |
❌ No | ✅ Yes |
| Rendering Method | Client-side (browser) | Server-side (Vercel Function) |
| Best For | Manual preview/download | Embedding in READMEs, wikis, dashboards |
Example Usage in Markdown:
<!-- Embed live blueprint image in your README -->
Add a url field to a node's metadata in the blueprint, and the node link becomes directly clickable in the interactive view.
Add an area field to a node's metadata to enable domain territory rendering on the canvas background.