---
title: "Install"
description: "Install: the Writing Room plugin for Sanity Studio."
canonical_url: https://writingroom.studio/docs/install/
plugin_version: 0.3.0
license: MIT
---

# Install

Three steps, from your Studio's folder.

**1. Add the package.**

```sh
npm install sanity-plugin-writing-room
```

**2. Add the plugin, with the document types you write in.**

```ts
// sanity.config.ts
import {writingRoom} from 'sanity-plugin-writing-room'

export default defineConfig({
  // …
  plugins: [structureTool(), writingRoom({types: ['post']})],
})
```

**3. Turn off Studio auto-updates.**

```ts
// sanity.cli.ts
export default defineCliConfig({
  // …
  deployment: {autoUpdates: false},
})
```

That's all. Run `sanity dev`: **Writing Room** appears in the Studio's navigation, and each of those documents gets an **Open in Writing Room** action.

**Which types?** Your own `post`, `article`, `caseStudy`… The room finds each one's title, body, slug and published date by itself (see [Document types](https://writingroom.studio/docs/document-types.md)) and only offers what its body can store. No Post type yet? Register the starter one: `schema: {types: writingRoomSchemaTypes}` (see [Schema](https://writingroom.studio/docs/schema.md)).

**Why auto-updates off?** The room uses Sanity's App SDK (`@sanity/sdk-react`). An auto-updating Studio loads `sanity` from a CDN but bundles its own copy of the SDK, so the two never share a React context and the room can't start. This only shows up in a **deployed** Studio, not in `sanity dev`. To upgrade later, bump `sanity` and deploy again.

---

Writing Room is MIT licensed and free, made by [Zephyr Pixels](https://zephyrpixels.dev). Bugs and questions go to [GitHub issues](https://github.com/mematthew123/sanity-plugin-writing-room/issues). More: [About](https://writingroom.studio/about.md), [Contact](https://writingroom.studio/contact.md), [Privacy](https://writingroom.studio/privacy.md).

Every page of this site as markdown: [https://writingroom.studio/llms.txt](https://writingroom.studio/llms.txt)