Skip to content

Setup

Installation

pnpm install arktype

You’ll also need…

VSCode

Settings

To take advantage of all of ArkType’s autocomplete capabilities, you’ll need to add the following to your workspace settings at .vscode/settings.json:

// allow autocomplete for ArkType expressions like "string | num"
"editor.quickSuggestions": {
	"strings": "on"
}

Extension (optional)

ArkDark provides the embedded syntax highlighting you’ll see throughout the docs.

Without it, your definitions can still feel like a natural extension of the language.

With it, you’ll forget there was ever a boundary in the first place.

Other editors

If you’re using a different editor, we’d love help adding support. In the meantime, don’t worry- ArkType still offers best-in-class DX anywhere TypeScript is supported.