ap-sdk
GitHubGet started

Installation

Add the SDK to your project and run the CLI.

Edit this page on GitHub

Install

$ pnpm add @jalco/ap-sdk

The package ships three entrypoints:

ImportUse
@jalco/ap-sdkThe portable definition layer (definePlugin, defineSkill, …) and the build/installSkills API.
@jalco/ap-sdk/runtimeAuthor custom tools (defineTool) whose handlers run across harnesses.
@jalco/ap-sdk/harnessAuthor a custom harness (defineHarness, registerHarness, emit helpers).

The CLI

The package exposes an ap-sdk binary:

ap-sdk build   [plugin] [options]   # Compile to native artifacts under an output dir
ap-sdk install [plugin] [options]   # Install artifacts into local harness dirs
ap-sdk check   [plugin]             # Validate a plugin definition
ap-sdk tools   [plugin] [options]   # List/invoke the plugin's tools locally
ap-sdk add-harness <id> [options]   # Scaffold a new target harness module
ap-sdk port  [dir] [options]         # Generate a portable plugin.ts from an existing plugin

If you omit [plugin], the CLI looks for plugin.ts, plugin.js, or ap-sdk.config.ts in the current directory.

Running a TypeScript plugin

The CLI loads a TypeScript plugin file directly via the bundled tsx loader, so this works as-is:

npx ap-sdk build ./plugin.ts

Plain .js/.mjs plugin files work with node and need no loader.

Requirements

  • Node.js >= 18.
  • Any package manager (pnpm, npm, bun). Examples use pnpm.

See the CLI reference for every flag.