Skip to content

Quickstart

Publish your first artifact in 2 minutes.

On this page

This walkthrough takes you from "no account" to a published artifact your teammates can open in a browser. Plan on under two minutes end to end.

If you'd rather see a working URL before installing anything, Publish without an account lets you publish with a single curl and claim the artifact later.

Install the CLI

The CLI is published as @displaydev/cli on npm. You can run it without installing globally:

bash
npx @displaydev/cli --help

Or install once for repeat use:

bash
npm install -g @displaydev/cli

The binary is named dsp.

Authenticate

Run dsp login and enter your work email. Display.dev sends a 6-digit OTP. Enter the code to finish.

bash
dsp login --email [email protected]

The CLI saves a session credential under ~/.displaydev/config.json. You can override the API URL via DISPLAYDEV_API_URL, or use an API key instead of a session.

Publish your first artifact

Pick any HTML file. We'll use a Playwright report, but anything works.

bash
dsp publish playwright-report/index.html --name "Q3 e2e"

The CLI prints the URL the moment the artifact lands. Open it in a browser — you'll be prompted to sign in if you aren't already, then the page renders with a thin Display.dev bar across the top showing the publisher and version.

Share it

By default the artifact is restricted to people in your organization. To make it public, repeat the publish with --public:

bash
dsp publish playwright-report/index.html --id <shortId> --public

Or to grant access to specific people outside your organization, leave visibility on the default (company) and add their email addresses with --share-with:

bash
dsp publish playwright-report/index.html --id <shortId> --share-with [email protected],[email protected]

Those two will receive a one-time-password email the first time they open the URL. See Visibility & sharing for the full access matrix and how sharedWith interacts with visibility levels.

What's next

  • Concepts — the small vocabulary used everywhere in these docs.
  • CLI reference — every subcommand and flag.
  • CI/CD — wire dsp publish into a build.

Was this page helpful?