The nSelf Plugin SDK is available in four languages. Each SDK provides the same core contracts — lifecycle hooks, schema migration helpers, metrics, health checks, and structured logging — adapted to the idioms of its language.

All four SDKs are MIT-licensed and published to their respective registries.

Go is the reference implementation. All other SDKs maintain behavioral parity with the Go SDK.

go get github.com/nself-org/cli/sdk/go/v2

Source: cli/sdk/go/ — published automatically when a sdk-go/v* tag is pushed.

Targets Node.js 18+ with ESM and CJS exports. Full TypeScript types included.

npm install @nself/plugin-sdk

Source: cli/sdk/ts/ — published automatically when a sdk-ts/v* tag is pushed.

Targets Python 3.11+. Built on FastAPI and asyncpg. Published as a wheel and sdist.

pip install nself-plugin-sdk
# with optional Postgres support:
pip install nself-plugin-sdk[db]

Source: cli/sdk/py/ — published automatically when a sdk-py/v* tag is pushed.

Targets Flutter 3.19+ and Dart 3.0+. Provides auth, GraphQL, storage, realtime, push, and functions helpers.

dependencies:
  nself_plugin_sdk: ^2.0.0

Source: cli/sdk/flutter/ — published automatically when a sdk-flutter/v* tag is pushed.

All four SDKs follow Semantic Versioning.

MAJOR versions are synchronized across all four SDKs. When one SDK ships a breaking change, all four bump to the same MAJOR in the same release cycle. MINOR and PATCH versions may diverge.

Before any breaking change ships:

1. Deprecation notice — mark the old API deprecated in the current MINOR release. Keep the old API working. Use //Deprecated: in Go, @deprecated JSDoc in TypeScript, Python deprecation warnings, and Dart @Deprecated.
2. Migration guide — commit MIGRATION.md to the SDK directory before the MAJOR release tag.
3. 30-day minimum notice — publish a deprecation notice in the changelog and announce to plugin authors at least 30 days before the MAJOR release.
4. RC tags required — tag at least one release candidate (e.g. sdk-go/v3.0.0-rc.1) and allow a two-week soak window before promoting to final.

Full policy: sdk/breaking-change-policy

Each SDK publishes via a dedicated GitHub Actions workflow triggered by a scoped tag:

Required repository secrets:

Go and Python publish via OIDC Trusted Publisher — no long-lived secret required.

Plugin SDKs version independently of the CLI. Compatibility is determined by the plugin protocol major version, not the CLI version.

• sdk/breaking-change-policy — full deprecation cycle, migration guide requirements, RC process
• Home