Skip to content

Latest commit

 

History

History
46 lines (40 loc) · 1.33 KB

quickstart.mdx

File metadata and controls

46 lines (40 loc) · 1.33 KB
title description
Quickstart
Start building truly user-centric software in under 5 minutes

Install

npm install @kontext21/k21

Use

const { K21 } = require('@kontext21/k21');
const k21 = new K21();
k21.setCapturer(); // defaults to 10s screen capture
k21.setProcessor(); // extract text with local OCR
const result = await k21.run()
console.log(result)

Sample Log Output

 {
   "message": "Successfully processed 1 video frames",
   "success": true,
   "result": [
     {
      "timestamp": "2025-03-05 13:44:12",
      "framenumber": 1,
      "content": "OPP Pv Vv k21-SCREEN ~_.github / workflows 25 ...",
      "processingType" : "OCR"
     }
    ]
 }

Returns all data currently on the screen.

Components of our SDK

  • k21 is the main repository for the SDK. Readme.
    • k21-screen - A CLI tool to handle screen captures
    • k21-processor - A CLI tool to handle processing of screen captures
    • k21-server - A server to handle the processing of screen captures with the processor and returning the results
  • k21-node - A Node.js Library for the SDK
  • K21-node-sample - Sample code for using the k21-node library