# @ucanto/core

> ucanto core

Latest version **10.4.6** (published 2025-10-27) · (Apache-2.0 AND MIT) license · 0 weekly downloads

## Install

```sh
npm install @ucanto/core
pnpm add @ucanto/core
yarn add @ucanto/core
bun add @ucanto/core
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 10.4.6 |
| Published | 2025-10-27 |
| First published | 2022-06-20 |
| Weekly downloads | 0 |
| License | (Apache-2.0 AND MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 159.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 62 |
| Maintainers | gozala, it-dag-house, hugomrdias |
| Keywords | UCAN, RPC, IPLD, JWT, multicodec, codec, invocation |

## Links

- npm: https://www.npmjs.com/package/@ucanto/core
- Repository: https://github.com/storacha/ucanto
- Issues: https://github.com/storacha/ucanto/issues
- npm.io page: https://npm.io/package/@ucanto/core

## Dependencies (5)

- [@ipld/car](https://npm.io/package/@ipld/car.md) ^5.1.0
- [multiformats](https://npm.io/package/multiformats.md) ^13.3.1
- [@ipld/dag-cbor](https://npm.io/package/@ipld/dag-cbor.md) ^9.0.0
- [@ipld/dag-ucan](https://npm.io/package/@ipld/dag-ucan.md) ^3.4.5
- [@ucanto/interface](https://npm.io/package/@ucanto/interface.md) ^11.0.1

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 10.4.6 (latest) — 2025-10-27
- 10.4.5 — 2025-10-24
- 10.4.2 — 2025-10-23
- 10.4.0 — 2025-05-13
- 10.3.1 — 2025-02-25
- 10.3.0 — 2025-02-13
- 10.2.1 — 2025-01-22
- 10.2.0 — 2025-01-20
- 10.1.1 — 2025-01-18
- 10.1.0 — 2025-01-17
- 10.0.1 — 2024-04-10
- 10.0.0 — 2024-04-04
- 9.0.1 — 2023-11-15
- 9.0.0 — 2023-10-05
- 8.2.0 — 2023-09-01
- … 33 more at https://npm.io/package/@ucanto/core/versions

## README

# @ucanto/core

`@ucanto/core` provides the foundational components for defining, validating, and executing UCAN-based Remote Procedure Calls (RPC). It serves as the core module for the `ucanto` ecosystem, enabling capability-based access control and secure interactions between clients and services.

## What It Provides
- **Capability Definition & Validation**: Enables the creation of structured capabilities with clear semantics.
- **UCAN Invocation Execution**: Supports processing and verifying UCAN-based RPC calls.
- **Extensibility**: Designed to integrate seamlessly with other `ucanto` modules.

## How It Fits with Other Modules
- [`@ucanto/server`](../server/README.md): Builds on `ucanto/core` to provide a complete UCAN-based RPC server.
- [`@ucanto/interface`](../interface/README.md): Provides shared type definitions and contracts.
- [`@ucanto/transport`](../transport/README.md): Implements encoding and transport mechanisms.
- [`@ucanto/principal`](../principal/README.md): Handles identity management and cryptographic operations.

For an overview and detailed usage information, refer to the [main `ucanto` README](../../Readme.md).

## Installation
```sh
npm install @ucanto/core
```

## Example Usage
```ts
import { capability, URI, Link } from '@ucanto/core';

const AddFile = capability({
  can: 'file/add',
  with: URI.match({ protocol: 'file:' }),
  nb: { link: Link }
});
```

For more details, see the [`ucanto` documentation](https://github.com/storacha/ucanto).

---
_Source: https://npm.io/package/@ucanto/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._