Skip to Content
SPAPS is proprietary hosted SaaS. Paid access required; pre-1.0 contracts may change. Terms and access
PackagesPackages Overview

Packages

The existing tutorial at /tutorials/local-development covers the Python + Make workflow. This section covers the npm package quickstart path and local runtime operated by spaps.

Source Compatibility Snapshot

Verified against Sweet Potato 5b09d3df1194577c5313c865fef1db98f694cdea:

SurfaceSource versionMinimum runtimeAuthoritative metadata
spaps CLI0.10.1Node.js 22packages/spaps/package.json
spaps-sdk1.14.1Node.js 14packages/sdk/package.json
Python spaps client0.7.1Python 3.9packages/python-client/pyproject.toml
spaps-server-quickstart0.7.1Python 3.12packages/python-server-quickstart/pyproject.toml

These are checkout versions. Before copying an example, compare your installed version; remote registries and deployed services can lag the source checkout.

npx spaps --version npm ls spaps-sdk python -c "from importlib.metadata import version; print(version('spaps'))" python -c "from importlib.metadata import version; print(version('spaps-server-quickstart'))"

When the published artifact does not match this snapshot, use the sibling checkout explicitly instead of silently mixing versions:

node ../sweet-potato/packages/spaps/bin/spaps.js --version npm install ../sweet-potato/packages/sdk pip install ../sweet-potato/packages/python-client pip install ../sweet-potato/packages/python-server-quickstart

These local-path installs prove source integration only; they do not prove registry publication.

Which quickstart should you use?

Start withUse it whenFirst command
npx spapsYou have a frontend or Node app and need local auth/runtime quickly without building backend infrastructure firstnpx spaps
spaps-server-quickstartYou are building or extending the FastAPI backend service in this repopip install spaps-server-quickstart

If you are changing backend routes, middleware, or migrations, stay on the Python path: /tutorials/first-service and /tutorials/local-development.

Pick The Surface

SurfaceInstall or entry pointOwnsFirst proof
SPAPS CLInpx spapsLocal runtime, app provisioning, fixtures, auth commands, diagnostics, domain control-plane commandsnpx spaps quickstart --json then npx spaps verify --json
TypeScript SDKnpm install spaps-sdkBrowser/server clients, sessions, payments, entitlements, issue reporting, webhook helpersCreate a browser or server client with the correct key type
Python clientpip install spapsServer-to-server auth, sessions, payments, entitlements, issue reporting, webhook helpersInstantiate SpapsClient against the selected API URL
Python quickstart packagepip install spaps-server-quickstartFastAPI app factory, settings, middleware, DB helpers, task setup, server-side helpersBuild the tutorial service and hit /health
Companion packagesSee Companion packagesShared types, wallet utilities, React issue-reporting UIRun the package-specific build or test command

Capability matrix

Use this matrix to find which package surface owns a feature; click into each package page for the API shape.

CapabilityTypeScript SDK (spaps-sdk)Python clientSPAPS CLICompanion packages
Auth & sessionauth and sessions namespacesauth, sessions, DeviceFlowClientspaps login / connect / whoami / token / logout
Billing & entitlementspayments and entitlements namespacespayments, EntitlementsClient
Walletspaps-wallet-utils (EVM connect/switch/sign)
Webhooks deliveryverifyCryptoWebhookSignatureverify_spaps_webhook, verify_crypto_webhook_signaturespaps webhook list / register
Issue reportingissueReporting namespaceIssueReportingClientspaps issue-reports list-minespaps-issue-reporting-react provider, hooks, and components
Local runtimespaps local, spaps status, spaps verify, spaps doctor
Reusable FastAPI appspaps-server-quickstart package API

npm Quickstart Path

npx spaps npx spaps local npx spaps quickstart --json npx spaps connect npx spaps verify --json npx spaps create demo-app --template react npx spaps fixtures apply --base-url http://localhost:5173

Package Docs In This Section