Quickstart

Generate config with the CLI, install Core, and make your first call in under five minutes

Prerequisites

• Node.js 20 or newer

1. Generate project config

   Install and run the Embeddables CLI from your app root:

   npm install -g @embeddables/em-cli
   em login
   em init
   

   This generates your project config with your projectId, forms, and experiments. init also prints your sandbox and live publishable keys — save the one you need for the next step.

2. Install Core

   Every other SDK composes on top of Core, so install it first.

   npm

   npm install @embeddables/core
   
3. Initialize it

   Import the generated config — do not build the object yourself:

   Vanilla / Node

   import { initEmbeddables } from '@embeddables/core'
   import { config } from './embeddables/_dist'
   
   const embeddables = initEmbeddables({
     ...config,
     publishableKey: 'pk_sandbox_<your-key>',
   })
   
   embeddables.getAppUserId()
   embeddables.getProjectId()
   

   React

   Install the React peer dependency, then wrap your app once:

   npm install react
   

   import { EmbeddablesProvider } from '@embeddables/core/react'
   import { config } from './embeddables/_dist'
   
   function App() {
     return (
       <EmbeddablesProvider
         config={{
           ...config,
           publishableKey: 'pk_sandbox_<your-key>',
         }}
       >
         <YourApp />
       </EmbeddablesProvider>
     )
   }
   

   Every hook from Analytics, Experiments, and Forms reads the instance from this provider — mount it once, above everything else.

4. Add the SDK you actually need

   Core alone doesn’t track anything or run experiments — it just resolves identity. Install whichever of the three product SDKs your feature needs:

   Analytics

   npm install @embeddables/analytics
   

   Then continue to that SDK’s guide: Analytics · Experiments · Forms.