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.tomlor 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/.ziparchive
§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,.dllfiles, orindex.ts/index.jsentries - Skills: Directories containing
SKILL.md - Prompts:
.mdfiles inprompts/subdirectory - Themes:
.jsonfiles inthemes/subdirectory
§Lockfile
An oxi-lock.json file records exact versions/refs for reproducibility.
Structs§
- Configured
Package - A configured package
- Discovered
Resource - A discovered resource within a package
- Lock
Entry - Lockfile entry for an installed package
- Lockfile
- The lockfile structure
- NpmPackage
Info - Information fetched from the npm registry
- Package
Manager - Manages installation, removal, and listing of packages
- Package
Manifest - Package manifest describing bundled resources
- Package
Update Info - Information about an available package update
- Path
Metadata - Metadata about a resolved resource path
- Progress
Event - Progress events for package operations
- Resolved
Paths - Resolved paths for all resource types
- Resolved
Resource - A resolved resource with metadata
- Resource
Counts - Counts of each resource type in a package
Enums§
- Parsed
Source - Parsed package source
- Progress
Action - Action being performed
- Progress
Event Type - Progress event type
- Resource
Kind - Types of resources a package can contribute
- Resource
Origin - Origin of a resource
- Source
Scope - 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§
- Progress
Callback - Callback for progress events