Installation

Colibri packages are published to JSR (JavaScript Registry) and designed for the Deno runtime.

Prerequisites

• Deno v2.0 or later

Installing Packages

Using Deno

Add packages directly to your project using deno add:

# Core package (required)
deno add jsr:@colibri/core

# RPC Streamer (optional)
deno add jsr:@colibri/rpc-streamer

# Fee Bump Plugin (optional)
deno add jsr:@colibri/plugin-fee-bump

This will add the packages to your deno.json imports map:

{
  "imports": {
    "@colibri/core": "jsr:@colibri/core@^0.16.0",
    "@colibri/rpc-streamer": "jsr:@colibri/rpc-streamer@^0.1.0",
    "@colibri/plugin-fee-bump": "jsr:@colibri/plugin-fee-bump@^0.8.0"
  }
}

Direct Import

You can also import directly from JSR URLs:

import { NetworkConfig, LocalSigner } from "jsr:@colibri/core@^0.16.0";
import { RPCStreamer } from "jsr:@colibri/rpc-streamer@^0.1.0";

Package Overview

@colibri/core

The foundation package containing all core primitives for Stellar and Soroban development: account management, contract client, network configuration, transaction pipelines and processes, event parsing, signers, and typed error handling.

@colibri/rpc-streamer

Generic RPC streaming framework for real-time and historical data ingestion (events, ledgers, or custom data types) with support for live streaming, archive fetching, and automatic mode switching.

Plugins

Use case-specific plugins extend pipeline and process behavior. Each plugin is published as its own package:

Plugin	Package	Description
Fee Bump	@colibri/plugin-fee-bump	Wrap transactions for third-party fee sponsorship

Stellar SDK Dependency

Colibri uses @stellar/stellar-sdk internally. You may need to import it directly for certain operations:

import { Keypair, xdr } from "npm:@stellar/stellar-sdk";

The SDK is re-exported through Colibri where needed, but for advanced XDR manipulation, you may want to add it explicitly:

deno add npm:@stellar/stellar-sdk

Next Steps

• Quick Start — Build your first transaction

• Architecture Overview — Understand the design principles