Coral

Appearance

Embed Coral ​

Choose a package, install only what your application needs, and compose Coral's public APIs from registry artifacts.

Choose a package ​

JobPackagePublic entry points
Parse, print, import, diagnose, or repair Coral text@coral-viz/languageroot, @coral-viz/language/parser, @coral-viz/language/printer, @coral-viz/language/formats
Render SVG or HTML and compute geometry@coral-viz/renderroot, @coral-viz/render/layout
Embed React editors and editing helpers@coral-viz/vizroot, @coral-viz/viz/editor, @coral-viz/viz/layout, @coral-viz/viz/text-editor
Expose Coral tools to an MCP client@coral-viz/mcp-serverexecutable coral-mcp
Add Coral syntax toolingtree-sitter-coralpackage main with tree-sitter@0.25.1

@graph-ir/core@0.2.1 is an external dependency used to validate GraphIR 2.0. It isn't one of Coral's five packages.

Shared requirements ​

  • Node.js 24.19.0 or newer is the consumer runtime for the four JavaScript packages. The 0.2.5 release itself is built with Node 26.8.2 and npm 12.0.2.
  • @coral-viz/viz has peers on React and React DOM 18.3 or 19 and @xyflow/react 12. Import the React Flow stylesheet once.
  • tree-sitter-coral compiles a native addon from source. Python is required on every supported native-build platform. Linux/Unix also needs make and a C/C++ toolchain; macOS needs Xcode Command Line Tools; Windows needs Visual Studio C++ build tools. npm 12 consumers must approve its lifecycle script before installation.
  • Coral 0.2.x APIs are additive against published 0.2.4. GraphIR's schema version is independent of the Coral package version. Existing GraphIR 1 data must follow the GraphIR 1-to-2 migration guide before it reaches Coral 0.2.5 APIs.

Install packages ​

These are the exact Coral 0.2.5 release recipes. They become registry-executable when Slice 80 publishes the immutable release artifacts.

For the canonical rendering chain:

sh
npm install @coral-viz/language@0.2.5 @coral-viz/render@0.2.5 \
  @graph-ir/core@0.2.1

For the React editor:

sh
npm install @coral-viz/viz@0.2.5 @coral-viz/render@0.2.5 \
  @graph-ir/core@0.2.1 \
  @xyflow/react@^12 react@^19 react-dom@^19

Install the MCP server or grammar only when you need those integrations. Their native and client-specific setup is in their reference pages.

Start with a workflow ​