# @emigrate/storage-fs

> A storage plugin for Emigrate for storing the migration history in a file

Latest version **0.4.8** (published 2025-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @emigrate/storage-fs
pnpm add @emigrate/storage-fs
yarn add @emigrate/storage-fs
bun add @emigrate/storage-fs
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.4.8 |
| Published | 2025-11-20 |
| First published | 2023-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 3 |
| Author | Aboviq AB |
| Maintainers | joakimbeng |
| Keywords | emigrate, emigrate-storage, plugin, migrations, storage |

## Links

- npm: https://www.npmjs.com/package/@emigrate/storage-fs
- Repository: https://github.com/aboviq/emigrate.git#main
- Homepage: https://github.com/aboviq/emigrate/tree/main/packages/storage-fs#readme
- Issues: https://github.com/aboviq/emigrate/issues
- npm.io page: https://npm.io/package/@emigrate/storage-fs

## Dependencies (1)

- [@emigrate/types](https://npm.io/package/@emigrate/types.md) 1.0.0

## Alternatives

- [localforage](https://npm.io/package/localforage.md) — 6.2M weekly downloads
- [localforage-observable](https://npm.io/package/localforage-observable.md) — 30.8K weekly downloads
- [@y/y](https://npm.io/package/@y/y.md) — 30.1K weekly downloads
- [@metaobjectsdev/render](https://npm.io/package/@metaobjectsdev/render.md) — 3.5K weekly downloads
- [@ledgerhq/coin-algorand](https://npm.io/package/@ledgerhq/coin-algorand.md) — 1.1K weekly downloads

## Recent versions

- 0.4.8 (latest) — 2025-11-20
- 0.4.7 — 2024-05-30
- 0.4.6 — 2024-02-05
- 0.4.5 — 2024-02-05
- 0.4.4 — 2024-01-22
- 0.4.3 — 2023-12-20
- 0.4.2 — 2023-12-19
- 0.4.1 — 2023-12-19
- 0.4.0 — 2023-12-19
- 0.3.3 — 2023-12-15
- 0.3.2 — 2023-12-14
- 0.3.1 — 2023-12-12
- 0.3.0 — 2023-12-08
- 0.2.1 — 2023-12-08
- 0.2.0 — 2023-11-24

## README

# @emigrate/storage-fs

A file system storage plugin for Emigrate, suitable for simple migration setups. To support containerized environments, it is recommended to use a database storage plugin instead.

## Installation

Install the storage plugin in your project, alongside the Emigrate CLI:

```bash
npm install @emigrate/cli @emigrate/storage-fs
# or
pnpm add @emigrate/cli @emigrate/storage-fs
# or
yarn add @emigrate/cli @emigrate/storage-fs
# or
bun add @emigrate/cli @emigrate/storage-fs
```

## Usage

Configure the storage in your `emigrate.config.js` file:

```js
import storageFs from '@emigrate/storage-fs';

export default {
  directory: 'migrations',
  storage: storageFs({ filename: '.migrated.json' }),
};
```

Or use the CLI option `--storage` (or `-s`):

```bash
emigrate up --storage fs  # the @emigrate/storage- prefix is optional
```

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