Skip to main content

Module packages

Module packages 

Source
Expand description

Package system for oxi CLI

Packages bundle extensions, skills, prompts, and themes for sharing. Supports local directories, npm packages, git repositories, GitHub shorthand, and URL-based archives.

§Package sources

  • Local path: a directory with oxi-package.toml or auto-discoverable resources
  • npm: npm:<package>[@<version>] — resolved from the npm registry
  • git: https://github.com/org/repo.git[@ref], git://…, git+ssh://…
  • GitHub shorthand: github:org/repo[@ref]
  • URL: direct .tar.gz / .zip archive

§Package manifest

A package is a directory containing an oxi-package.toml file:

name = "@foo/oxi-tools"
version = "1.0.0"
extensions = ["ext/index.ts"]
skills = ["skills/code-review/SKILL.md"]
prompts = ["prompts/review.md"]
themes = ["themes/dark-pro.json"]

§Resource discovery

When a package lacks explicit resource lists, resources are discovered automatically by scanning the package directory:

  • Extensions: .so, .dylib, .dll files, or index.ts/index.js entries
  • Skills: Directories containing SKILL.md
  • Prompts: .md files in prompts/ subdirectory
  • Themes: .json files in themes/ subdirectory

§Lockfile

An oxi-lock.json file records exact versions/refs for reproducibility.

Structs§

ConfiguredPackage
A configured package
DiscoveredResource
A discovered resource within a package
LockEntry
Lockfile entry for an installed package
Lockfile
The lockfile structure
NpmPackageInfo
Information fetched from the npm registry
PackageManager
Manages installation, removal, and listing of packages
PackageManifest
Package manifest describing bundled resources
PackageUpdateInfo
Information about an available package update
PathMetadata
Metadata about a resolved resource path
ProgressEvent
Progress events for package operations
ResolvedPaths
Resolved paths for all resource types
ResolvedResource
A resolved resource with metadata
ResourceCounts
Counts of each resource type in a package

Enums§

ParsedSource
Parsed package source
ProgressAction
Action being performed
ProgressEventType
Progress event type
ResourceKind
Types of resources a package can contribute
ResourceOrigin
Origin of a resource
SourceScope
Scope for package sources

Functions§

get_latest_npm_version
Get the latest version of an npm package
git_clone
Clone a git repository
git_has_update
Check if a git repo has remote updates available
git_update
Pull/update a git repository in place

Type Aliases§

ProgressCallback
Callback for progress events