Skip to main content

Quickstart

Welcome to AirGapKit. This quickstart gets you from install to a working importer in a few minutes.

Prerequisites​

  • Node.js 18+ and a package manager (pnpm, npm, or yarn)
  • A modern browser environment (for in-browser WASM and workers)
  • A schema ID you want to import into (for now, use contacts as a placeholder)

Install the SDK​

pnpm add @airgapkit/import-react
# or: npm install @airgapkit/import-react

Minimal React usage​

import {AirgapImporter} from '@airgapkit/import-react';

export function ContactsImport() {
  return (
    <AirgapImporter
      schemaId="contacts"
      onSuccess={(rows) => {
        // Handle clean rows after parsing, validation, and masking.
        console.log('Imported rows', rows);
      }}
    />
  );
}

Next steps​

  • Connect your own schema, validation rules, and masking policies.
  • Wire analytics callbacks to observe pipeline health.
  • Continue with the deeper guides in Getting Started.