Skip to content

Recipes

Prompts and commands for work that an agent publishes to a link and keeps current.

On this page

Each recipe is one prompt for your agent, plus the commands that the agent runs. The agent publishes HTML or Markdown to Display.dev and keeps the same URL on every run. It shares the result with your organization or with invited people. Recipes work in Cursor, Codex, Claude Code, Claude and any other agent that has the Display.dev MCP server or the dsp CLI. Copy the prompt, replace the names in angle brackets, and send it to your agent.

To connect your agent first, see the Quickstart. Each recipe lists the plan it needs. See Plans and limits for all limits.

RecipePlan needed
Weekly report to one URLSolo for versions. Free for one version.
A dashboard the agent refreshesSolo
A CI run that publishes its test reportFree, or Solo for older versions
Rescue a Claude artifactFree
Work through commentsFree
See who viewed whatSolo for counts, Pro for viewer identity
Publish a Markdown spec and keep it currentFree, or Solo for older versions

Free allows 3 gated artifacts (Company or Private) and keeps only the latest version. Solo keeps 10 versions and Pro keeps 50. The recipes publish with Company access, so members of your organization open the result after they sign in.

Weekly report to one URL

Use this for a report the agent rebuilds each week. The first run creates the artifact. Each later run publishes the next version at the same URL.

Build this week's pipeline report as one self-contained HTML file. Look for an existing Display.dev artifact named Pipeline report. If it exists, publish the new file as the next version at the same URL. If it does not exist, publish it with Company access. Return the link.

The commands behind it:

bash
dsp publish pipeline.html --name "Pipeline report" --company
dsp get-metadata <shortId>
dsp publish pipeline.html --id <shortId> --base-version <currentVersion>

Run the first command once. Run the second and third each week. See Update an artifact.

A dashboard the agent refreshes

Use this for a page with charts and tables. The agent rebuilds the file from new data and updates the artifact.

Rebuild the sales dashboard from <data source> as one self-contained HTML file with the data and scripts inline. Publish it to the Display.dev artifact named Sales dashboard as the next version, keep the access setting, and return the link.

Add --reload when you want open tabs to refresh as soon as the new version is ready:

bash
dsp publish dashboard.html --id <shortId> --base-version <currentVersion> --reload

Leave --reload off for a dashboard that people are commenting on. A refresh can interrupt a reader who is writing.

A CI run that publishes its test report

Use this to give the team a link to the latest test report. Build one HTML file in the pipeline. Publish it in the next step.

yaml
- run: npm run test:report
- if: always()
  run: |
    BASE_VERSION=$(npx -y @displaydev/cli get-metadata "${{ vars.DISPLAY_ARTIFACT_ID }}" | jq -r .currentVersion)
    npx -y @displaydev/cli publish report.html --id "${{ vars.DISPLAY_ARTIFACT_ID }}" --base-version "$BASE_VERSION" --actor-name ci-tests
  env:
    DISPLAYDEV_API_KEY: ${{ secrets.DISPLAYDEV_API_KEY }}

Create the artifact once by hand, then store its short ID in the variable DISPLAY_ARTIFACT_ID. Store the API key in the secret DISPLAYDEV_API_KEY. if: always() publishes the report when tests fail. See Publish from CI/CD for GitLab CI and the audit-log label.

Rescue a Claude artifact

Use this when Claude made an HTML page in a chat and only you can open it.

Publish the HTML page you just made to Display.dev with Company access. Give it a clear name. Return the link.

On Claude, add Display from Claude's connector directory first. In Claude Code, the agent runs dsp publish page.html --company. To publish without an account, see Publish without an account. That path creates a public preview for 30 days, so do not use it for private work.

Work through comments

Use this when colleagues left comments on an artifact. The agent reads the open discussions, changes the text, replies and resolves them.

Find the Display.dev artifact named <name>. Review its open discussions, make the requested changes when they are clear, reply with what changed, and resolve only the discussions you addressed. Return the updated link and list anything that still needs my decision.

The commands behind it:

bash
dsp comment list --artifact <shortId>
dsp comment add --artifact <shortId> --parent <rootCommentId> --body "Updated in the current version."
dsp thread resolve <rootCommentId>

See Review comments. Invited people outside your organization can view an artifact but cannot comment yet.

See who viewed what

Use this to see who views a report. Viewer counts need Solo or higher. Viewer identity needs Pro or higher. Open Stats in the dashboard to see them. No dsp command or MCP tool returns viewer statistics, so ask your agent to remind you to look.

The artifact header also shows the signed-in people who have the artifact open now. Invited people outside your organization appear as Guest, and the list shows the version that each person views. See Sharing and access. Display.dev does not send a notification when someone first opens an artifact.

On Friday, remind me to open the Display.dev dashboard and check who viewed the Pipeline report.

Publish a Markdown spec and keep it current

Use this for a specification or plan that changes often. A .md file renders as a themed page.

Write the spec for <feature> as Markdown. Publish it to Display.dev with Company access. When I send changes, edit the exact passage, publish the update at the same URL, and return the link.

The commands behind it:

bash
dsp publish spec.md --name "Checkout spec" --company
dsp edit <shortId> --base-version <currentVersion> --old "Status: Draft" --new "Status: Approved"

A Markdown artifact stays Markdown. Publish a new artifact to change formats. See Markdown rendering.

Was this page helpful?