Install spek

spek reads a repository that has an openspec/ directory. Each form below shows the same views (Browsing); the GitHub Action builds a static page instead of running on your machine.

VS Code

Install spek — OpenSpec Viewer from the Visual Studio Marketplace (it is also on Open VSX). It needs VS Code 1.85 or later.

It activates when the workspace contains openspec/config.yaml.
The spek icon in the Activity Bar opens a sidebar with your specs (nested by folder) and changes; clicking an item opens the full viewer panel.
Commands: spek: Open spek, spek: Search OpenSpec, spek: Open Dashboard.
Settings:

Setting What it does Default

spek.aggregateWorktrees Show the changes of every git worktree of the repository true

spek.aggregateJjWorkspaces Experimental: also show jj workspaces false

The panel’s scope control writes these settings, and editing them updates the control (Worktree aggregation).

Setting	What it does	Default
`spek.aggregateWorktrees`	Show the changes of every git worktree of the repository	`true`
`spek.aggregateJjWorkspaces`	Experimental: also show jj workspaces	`false`

JetBrains IDEs

Install spek - OpenSpec Viewer from the JetBrains Marketplace — or search for “spek” in Settings › Plugins › Marketplace. It works in IntelliJ IDEA, WebStorm, PyCharm, PhpStorm, GoLand, RubyMine, CLion, Rider, and other IntelliJ-based IDEs, 2023.3 or later.

It activates when the project contains an openspec/ directory.
Open it from the spek tool window in the right sidebar, or Tools › Open spek.
It renders inside the IDE when the IDE has its embedded browser (JCEF); otherwise it opens the same page in your default browser.
The plugin does not aggregate worktrees.

Web app

The web app runs from spek’s source; it is not published as a package. You need Node.js 22 or later and git.

git clone https://github.com/spekhq/spek.git
cd spek
npm install
npm run dev

Open http://localhost:5173, enter the path of a repository that contains an openspec/ directory, and browse. npm run dev starts two local processes: the page on port 5173 and the API it reads from on port 3001 (Data and network).

The OpenSpec CLI

spek reads openspec/ itself. When the OpenSpec CLI is installed, spek also asks it about the repository’s workflow schemas; without it, everything else works and what spek can say about schemas is limited.