max3a3/devbookhq-sdk

SDK for managing Devbook sessions

Devbook SDK

Installation

npm install @devbookhq/sdk

Usage

JS/TS

import { Session } from '@devbookhq/sdk'

async function main() {
  const session = new Session({
    id: '<code-snippet-id>',
    codeSnippet: {
      onStateChange(state) {
        console.log(state)
      },
      onStderr(stderr) {
        console.log(stderr)
      },
      onStdout(stdout) {
        console.log(stdout)
      },
    },
  })

  try {
    await session.open()
    await session.codeSnippet?.run('console.error("test")')
  } catch (e) {
    console.error(e)
  }
}

main()

Development

Subtrees

shared

Shared is a subtree made from https://github.com/devbookhq/shared repository.

The subtree commands you need for controling this repo are:

git subtree add --prefix shared https://github.com/devbookhq/shared.git master

git subtree pull --prefix shared https://github.com/devbookhq/shared.git master

git subtree push --prefix shared https://github.com/devbookhq/shared.git master

Performance

Every 8 hours runs an automated CRON on GitHub that measures time to acquire a session. You can inspect the performance summaries in the GH Actions' details - in the workflow "Measure performance". You can also trigger this workflow manually.

The GitHub Actions CRON is not very reliable so don't rely it on running every 8 hours.