ResourceX

The resource infrastructure and solution for AI Agents

AI 智能体的资源基础设施和解决方案

Manage, version, and share prompts, tools, skills, and everything

管理、版本化、共享 prompts、tools、skills 以及一切

Decentralized · Extensible · Universal

去中心化 · 可扩展 · 通用

English | 简体中文

Quick Start • Documentation • API Reference

---

Why ResourceX?

AI Agents need to manage various resources: prompts, tools, agents, skills, configurations, and more. ResourceX provides a unified resource layer with protocol, runtime, and registry. Everything is a resource.

┌─────────────────────────────────────────────────────────────┐
│                     Registry Layer                          │
│                                                             │
│  Local / Remote          →  Storage & Discovery             │
│  add / resolve / search  →  Resource Operations             │
├─────────────────────────────────────────────────────────────┤
│                    ResourceX Layer                          │
│                                                             │
│  RXL (Locator)   →  deepractice.ai/assistant.prompt@1.0.0  │
│  RXM (Manifest)  →  Resource metadata                       │
│  RXA (Archive)   →  tar.gz for storage/transfer             │
│  RXP (Package)   →  Extracted files for runtime access      │
│  Type System     →  text / json / binary / custom           │
├─────────────────────────────────────────────────────────────┤
│                       ARP Layer                             │
│                                                             │
│  Format: arp:{semantic}:{transport}://{location}            │
│  Low-level I/O primitives for file, http, https, rxr        │
└─────────────────────────────────────────────────────────────┘

Quick Start

npm install resourcexjs
# or
bun add resourcexjs

import { createRegistry, parseRXL, createRXM, createRXA } from "resourcexjs";

// 1. Create a resource (RXR = Locator + Manifest + Archive)
const manifest = createRXM({
  domain: "localhost",
  name: "my-prompt",
  type: "text",
  version: "1.0.0",
});

const rxr = {
  locator: parseRXL(manifest.toLocator()),
  manifest,
  archive: await createRXA({ content: "You are a helpful assistant." }),
};

// 2. Add to local registry (~/.resourcex)
const registry = createRegistry();
await registry.add(rxr);

// 3. Resolve and execute
const resolved = await registry.resolve("localhost/my-prompt.text@1.0.0");
const text = await resolved.execute(); // "You are a helpful assistant."

// Access the original resource
console.log(resolved.resource.manifest.name); // "my-prompt"

Documentation

Getting Started

• Introduction - What is ResourceX
• Installation - Setup guide
• Quick Start - 5-minute tutorial

Core Concepts

• Architecture Overview - Two-layer design
• ResourceX Layer
  • RXL - Locator - domain/path/name.type@version
  • RXM - Manifest - Resource metadata
  • RXA - Archive - Archive for storage/transfer
  • RXR - Resource - Complete resource object
  • Type System - Built-in & custom types
  • Registry - Storage & retrieval
• ARP Layer
  • Protocol - Agent Resource Protocol
  • ARL - ARP Resource Locator
  • Transport - file, http, https, rxr
  • Semantic - text, binary

Guides

• Local Registry - Development workflow
• Git Registry - Team sharing
• Remote Registry - HTTP API
• Custom Types - Define your own types
• ARP Protocol - Low-level I/O

API Reference

• Core API - RXL, RXM, RXA, RXP, RXR
• Registry API - Registry operations
• ARP API - Transport & Semantic
• Errors - Error handling

Design & Contributing

• Design Decisions - Architecture rationale
• Development - Setup & commands
• Workflow - BDD process
• Conventions - Code style

Packages

Package	Description
resourcexjs	Main package - everything you need
@resourcexjs/core	Core types (RXL, RXM, RXA, RXP, RXR)
@resourcexjs/registry	Registry implementations
@resourcexjs/arp	ARP protocol

Ecosystem

Part of the Deepractice AI infrastructure:

• AgentVM - AI Agent runtime
• AgentX - AI Agent framework
• ResourceX - Resource management (this project)

Contributing

See CONTRIBUTING.md and Development Guide.

License

MIT

---

Built with care by Deepractice