Dashboard beta
Get started
Dashboard runs a Sanity Studio or SDK app inside the shared Dashboard host instead of as a standalone app. This guide creates a new app configured for Dashboard. To move an existing SDK app, see Migrate an existing application.
1Step 1: Create a Dashboard-ready app
Use the bare command for a Studio, or add the App SDK template for a custom app:
npx sanity@latest init --dashboard
npx sanity@latest init --dashboard --template app-quickstart
2Step 2: Inspect the CLI configuration
The generated sanity.cli.ts config opts your app into the local Dashboard environment. A Studio does not need an entry point.
Whilst the name and slug are both the same in the above example the name field cannot be changed after deployment, however the slug field can.
import {defineCliConfig, defineApplication} from 'sanity/cli'
export default defineCliConfig({
app: defineApplication({
name: 'content-app',
slug: 'content-app',
title: 'Content app',
organizationId: 'YOUR_ORGANIZATION_ID',
entry: './src/App.tsx',
}),
})3Step 3: Run the app in Dashboard
Start the development server:
Dashboard will start on the configured port. Open the URL printed by the CLI and you’ll be redirected to your local app or studio.
npx sanity@latest devpnpm dlx sanity@latest dev
yarn dlx sanity@latest dev
bunx sanity@latest dev