> For the complete documentation index, see [llms.txt](https://fifo-docs.gitbook.io/colibri/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://fifo-docs.gitbook.io/colibri/readme.md). # Introduction {% hint style="info" %} Colibri packages have independent versions. See \[compatibility and releases]\(getting-started/compatibility.md) for the stability and versioning policy. {% endhint %}
Colibri
Colibri is a TypeScript toolkit for Stellar applications. Use a [focused client](/colibri/colibri-core/overview.md#choose-a-layer) for a common workflow, a [transaction pipeline](/colibri/colibri-core/pipelines.md) when you need to attach [plugins](/colibri/plugins/plugins.md), or an individual [process](/colibri/colibri-core/processes.md) when you need to control orchestration. These guides explain **how and why** to use the APIs. The [API and error reference](/colibri/reference/reference.md) links every package's generated symbol documentation and lists every declared error code by context. ## Choose your task | I want to… | Start here | | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | Install a package and submit a payment | [Installation](/colibri/getting-started/installation.md), [first transaction](/colibri/getting-started/quick-start.md) | | Read or invoke a Soroban contract | [Contract tutorial](/colibri/getting-started/contract-call.md), [Contract client](/colibri/colibri-core/contract.md) | | Generate a typed contract client | [Contract Bindings](/colibri/colibri-contract-bindings/contract-bindings.md) | | Build a React application | [React setup](/colibri/colibri-react/setup.md), [common workflows](/colibri/colibri-react/convenience.md) | | Choose fees, signers, and authorization | [Transaction config](/colibri/colibri-core/transaction-config.md), [authorization](/colibri/colibri-core/authorization.md) | | Adjust Soroban budgets and resource fees | [Resource overrides, padding and calculation](/colibri/colibri-core/transaction-config/resources.md) | | Read current ledger state | [Ledger Entries](/colibri/colibri-core/ledger-entries.md) | | Follow events or historical ledgers | [RPC Streamer](/colibri/colibri-rpc-streamer/rpc-streamer.md) | | Authenticate a wallet or contract account | [WebAuth](/colibri/colibri-webauth/webauth.md) | | Rebuild and compare a contract's Wasm | [Build Verification](/colibri/colibri-build-verification/build-verification.md) | | Render an account or contract identicon | [Identicons](/colibri/colibri-identicon/identicon.md) | | Run a disposable local ledger | [Test Tooling](/colibri/colibri-test-tooling/test-tooling.md) | ## Packages Install only the packages your application needs. Events, account/address helpers, ledger readers, and transaction orchestration belong to Core; the other packages provide focused capabilities. | Package | Scope | | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- | | [`@colibri/core`](/colibri/colibri-core/overview.md) | Accounts, assets, contracts, signing, processes, pipelines, ledger data, and events | | [`@colibri/contract-bindings`](/colibri/colibri-contract-bindings/contract-bindings.md) | Typed clients, validated values and event definitions from a contract ABI | | [`@colibri/react`](/colibri/colibri-react/react.md) | Providers, wallet connections, queries and explicit transaction hooks | | [`@colibri/rpc-streamer`](/colibri/colibri-rpc-streamer/rpc-streamer.md) | Live/archive ingestion with callbacks and checkpoints | | [`@colibri/webauth`](/colibri/colibri-webauth/webauth.md) | [SEP-10](/colibri/colibri-webauth/sep10.md) and [SEP-45](/colibri/colibri-webauth/sep45.md) client authentication | | [`@colibri/build-verification`](/colibri/colibri-build-verification/build-verification.md) | SEP-58 and caller-supplied reproducible build verification, API and CLI | | [`@colibri/identicon`](/colibri/colibri-identicon/identicon.md) | [SEP-33](/colibri/colibri-identicon/identicon.md) SVG, PNG and image data, with extended C-address support | | [`@colibri/plugin-fee-bump`](/colibri/plugins/fee-bump.md) | Fee sponsorship for transaction pipelines | | [`@colibri/plugin-channel-accounts`](/colibri/plugins/channel-accounts.md) | Reusable sponsored transaction-source accounts | | [`@colibri/plugin-sep29`](/colibri/plugins/sep29.md) | Opt-in receiving-account memo checks | | [`@colibri/test-tooling`](/colibri/colibri-test-tooling/test-tooling.md) | Docker-backed Stellar Quickstart lifecycle | ## How to read the guides Start with a complete tutorial, then follow the scoped guides for configuration, failure handling, or customization. Short fragments illustrate one step; they are not independent scripts unless explicitly labeled. Placeholder secrets, contract IDs, and example domains must be supplied by your application. The [architecture guide](/colibri/getting-started/architecture.md) explains the shared process β†’ step β†’ pipeline β†’ client layering. The [error-handling guide](/colibri/colibri-core/error.md) explains stable codes and safe diagnostics. ## Resources * [Colibri source](https://github.com/fazzatti/colibri) * [Runnable examples repository](https://github.com/fazzatti/colibri-examples) * [Stellar developer documentation](https://developers.stellar.org/)