# @x12i/catalox-storage

> Catalox object storage (Cloudflare R2 / S3-compatible)

Latest version **6.0.0** (published 2026-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @x12i/catalox-storage
pnpm add @x12i/catalox-storage
yarn add @x12i/catalox-storage
bun add @x12i/catalox-storage
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2026-07-11 |
| First published | 2026-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20 |
| Dependencies | 1 |
| Unpacked size | 23.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | x12i |

## Links

- npm: https://www.npmjs.com/package/@x12i/catalox-storage
- Repository: https://github.com/x12i/catalox
- Homepage: https://github.com/x12i/catalox#readme
- Issues: https://github.com/x12i/catalox/issues
- npm.io page: https://npm.io/package/@x12i/catalox-storage

## Dependencies (1)

- [@x12i/helpers](https://npm.io/package/@x12i/helpers.md) ^1.7.0

## Recent versions

- 6.0.0 (latest) — 2026-07-11

## README

# `@x12i/catalox-storage`

Cloudflare R2 / S3-compatible object store for Catalox (record history, catalog lifecycle manifests, backups).

## Quick start

```ts
import { createObjectStoreFromEnv } from "@x12i/catalox-storage";

const store = createObjectStoreFromEnv(); // bucket default: catalox
await store.uploadObject("hello.txt", "hi", { contentType: "text/plain" });
```

## Env

| Variable | Purpose |
|----------|---------|
| `S3_API` / `S3_ENDPOINT` | R2 endpoint |
| `S3_ACCOUNT_ID` / `S3_ACOUNT_ID` | Builds endpoint if `S3_API` unset |
| `S3_ACCESS_ID` | Access key id |
| `S3_SECRET_ACCESSKEY` | Secret |
| `S3_TOKEN` | Optional session token |
| `S3_BUCKET` / `CATALOX_BUCKET` / `CATALOX_OBJECT_STORE_BUCKET` | Bucket (default **`catalox`**) |

Buckets are **not** auto-created. Create `catalox`, `magit`, and `storage` in Cloudflare before migrate/runtime use.

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