> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.ollang.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ollang SDK

> Official TypeScript/Node.js SDK for Ollang – Translation Management, Browser CMS Capture, Orders, and API Integration.

# Ollang SDK

The **Ollang SDK** (`@ollang-dev/sdk`) is the official TypeScript/Node.js library for integrating Ollang's translation and localization platform into your projects. Use it to scan i18n files, manage translations, capture CMS content in the browser, and programmatically create orders.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="bolt" href="/sdk/quickstart">
    Install, configure, and run your first scan in minutes.
  </Card>

  <Card title="Features" icon="wrench" href="/sdk/features">
    Asset Management, Browser SDK, Node API, and more.
  </Card>
</CardGroup>

## What's Included

The SDK provides three main integration points:

| Component                   | Use Case                                                      | Package                   |
| --------------------------- | ------------------------------------------------------------- | ------------------------- |
| **Ollang Asset Management** | Scan i18n files, translate, apply to codebase                 | `@ollang-dev/sdk`         |
| **Browser SDK**             | Capture CMS content (Strapi, etc.) in the browser             | `@ollang-dev/sdk/browser` |
| **Node API Client**         | Create orders, manage projects, upload files programmatically | `@ollang-dev/sdk`         |

## Key Features

* **Local i18n scanning** — Detect hardcoded strings, i18n keys, videos, images, and audio in your codebase
* **Translation workflow** — Translate selected items via Ollang, apply results back to files
* **CMS content capture** — Integrate with Strapi or custom CMS; capture content in-browser for translation
* **Folder-based organization** — Keep local and CMS content separate with named folders
* **Kanban-style UI** — Visual dashboard (Scanned → Translating → Translated → Submitted)
* **REST API client** — Orders, projects, uploads, revisions, custom instructions

## Prerequisites

* **Node.js** 16 or higher
* An [Ollang account](https://lab.ollang.com) and API key
* For Asset Management: a project with i18n files (Next.js, React, Vue, or custom)
* For Browser: a website with CMS content (e.g., Strapi)

## Architecture

```mermaid theme={null}
flowchart TD
    subgraph Project["Your Project"]
        direction LR

        subgraph SDK["@ollang-dev/sdk"]
            NodeAPI["Node API Client<br/>(Asset Management)"]
        end

        subgraph BrowserSDK["@ollang-dev/sdk/browser"]
            Browser["Browser SDK<br/>(CMS Capture)"]
        end

        subgraph LocalServer["npx @ollang-dev/sdk start"]
            Server["Local Server"]
        end
    end

    Project -->|X-Api-Key auth| OllangAPI["Ollang Integration API<br/>(orders, uploads, etc.)"]

    NodeAPI -.-> Server
    Browser -.-> Server
```

## Next Steps

<CardGroup cols={2}>
  <Card title="Quick Start" icon="bolt" href="/sdk/quickstart">
    Get the Asset Management running and perform your first scan.
  </Card>

  <Card title="Features" icon="wrench" href="/sdk/features">
    Deep dive into Asset Management, Browser SDK, and Node API.
  </Card>
</CardGroup>