@ramarivera/pi-ts-aperture-provider
Config-driven aperture provider extraction for Pi-compatible extensions.
Package details
Install @ramarivera/pi-ts-aperture-provider from npm and Pi will load the resources declared by the package manifest.
$ pi install npm:@ramarivera/pi-ts-aperture-provider- Package
@ramarivera/pi-ts-aperture-provider- Version
0.2.11- Published
- Apr 15, 2026
- Downloads
- 2,149/mo · 13/wk
- Author
- ramarivera
- License
- MIT
- Types
- extension
- Size
- 61.7 KB
- Dependencies
- 0 dependencies · 2 peers
Pi manifest JSON
{
"extensions": [
"./extensions"
]
}Security note
Pi packages can execute code and influence agent behavior. Review the source before installing third-party packages.
README
@ramarivera/pi-ts-aperture-provider
Shared Aperture provider runtime for Pi, published as both:
- a reusable TypeScript runtime library
- a Pi package with a bundled extension entrypoint in
extensions/index.ts
What lives here
- OpenAI-compatible
/modelsgateway fetching - models.dev catalog indexing and metadata enrichment
- provider-metadata-driven API resolution for Pi-style provider registrations
- config-driven overrides for provider aliases and individual models
- a packaged Pi extension that registers the provider directly inside Pi
What does not live here
- hardcoded Aperture base URLs
- hardcoded provider names
- freeform heuristic capability inference from arbitrary model IDs
Quick start
corepack yarn install
corepack yarn test
corepack yarn build
Install as a Pi package
This package is now Pi-installable.
Super simple setup
pi install npm:@ramarivera/pi-ts-aperture-provider@0.2.11
That is enough for Pi to load the extension. Pi discovers the packaged extension from package.json -> pi.extensions and loads extensions/index.ts automatically. If you do not provide your own config yet, the extension falls back to the bundled aperture-provider.config.example.json as a bootstrap default; most installs should still copy and customize that file.
If you prefer to do it manually instead of pi install, add this to ~/.pi/agent/settings.json:
{
"packages": [
"npm:@ramarivera/pi-ts-aperture-provider@0.2.11
]
}
Configuration
Copy aperture-provider.config.example.json to one of these locations:
PI_APERTURE_PROVIDER_CONFIG=/absolute/path/to/file.json<project>/.pi/aperture-provider.config.json~/.pi/agent/aperture-provider.config.json- package-local
aperture-provider.config.jsonnext to the installed package (mainly useful for local development) - bundled package fallback
aperture-provider.config.example.jsonnext to the installed package (used automatically when no higher-priority config exists)
Example:
mkdir -p ~/.pi/agent
cp aperture-provider.config.example.json ~/.pi/agent/aperture-provider.config.json
Adjust at least:
providerNamebaseUrlapiKeymodelsDev.providerAliasesresolution.apiRulesfallbackMetadatamodelOverrides
For Aperture, baseUrl should be the primary gateway root the extension uses everywhere. In Ramiro's current setup that is:
{
"baseUrl": "https://aperture-ai.xalda-procyon.ts.net/v1"
}
Runtime behavior
This runtime resolves capabilities from multiple layers, in order:
- API type from Aperture provider metadata such as
/v1/messages,/v1/responses, or/v1/chat/completions - provider compatibility from
/aperture/configwhen available - pricing from the Aperture
/modelspayload when present - explicit
modelOverrides - reasoning, modalities, and token limits from models.dev
fallbackMetadatafrom your JSON config- bundled conservative fallback metadata for a small set of well-known model families when upstream metadata is missing
The fallback layer is intentionally conservative. It is not freeform model-name guessing. You can edit fallbackMetadata in your aperture-provider.config.json without republishing the library, and those entries override the bundled defaults.
If a model still lacks required capability metadata after those layers, the runtime warns and skips that model by default instead of crashing the entire sync. If you want strict behavior, set resolution.skipModelsMissingCapabilities to false.
Provider sync now uses a persisted registration cache. On startup it reads the cached provider registration first, returns quickly, and refreshes in the background when a cache entry exists. The default cache path is:
~/.pi/agent/cache/aperture-provider/<provider-name>.json
If you want warning output while debugging cache refreshes or missing metadata, set PI_APERTURE_DEBUG=1. In normal mode those warnings are returned in runtime state but not dumped to the console.
Example config override:
{
"fallbackMetadata": {
"k2.5": {
"reasoning": true,
"input": ["text"],
"contextWindow": 262144,
"maxTokens": 16384
}
}
}
Using the library directly
If you want your own custom Pi extension or another integration layer, use the runtime exports directly:
import {
createApertureProviderRuntime,
loadResolvedApertureProviderConfig,
} from "@ramarivera/pi-ts-aperture-provider";
const { config } = await loadResolvedApertureProviderConfig();
const runtime = createApertureProviderRuntime(config, {
cachePath: "/tmp/aperture-provider-cache.json", // optional
debug: process.env.PI_APERTURE_DEBUG === "1", // optional
});
Repository layout
Publishing
The package is configured to publish to npm as @ramarivera/pi-ts-aperture-provider.
Before publishing:
corepack yarn install
corepack yarn run check
corepack yarn test
corepack yarn typecheck
corepack yarn build
npm whoami
Publish with:
npm publish
For prereleases (for example 0.2.5-beta.0), publish with:
npm publish --tag beta