Installation

Pre-built native binaries for all platforms. No build tools, no compiler required.

npm (recommended)#

npm install arcflow

The SDK includes pre-built native binaries for all major platforms:

pnpm / yarn#

pnpm add arcflow
# or
yarn add arcflow

Local development (from source)#

If you hold a source license and are building from the engine source:

# Build and link the native module per the source license build guide
npm run build
npm install

See the source license build guide for platform-specific instructions.

Verify installation#

import { openInMemory } from 'arcflow'
 
const db = openInMemory()
db.mutate("CREATE (n:Hello {message: 'It works!'})")
const result = db.query("MATCH (n:Hello) RETURN n.message")
console.log(result.rows[0].get('message'))  // "It works!"
db.close()

Environment variables#

Requirements#

• Node.js 18+ (LTS recommended)
• No native build tools needed — pre-built binaries are included

See Also#

• Quickstart — first query in under 5 minutes
• Project Setup — world model workspace layout and configuration
• Language Bindings — Node.js, Python, Rust, Go, WASM, and CLI