# @sdelements/flan > A tasty tool that lets you save, load and share postgres snapshots with ease. Latest version **0.1.0-alpha.13** (published 2026-10-22) · MIT license · 0 weekly downloads ## Install ```sh npm install @sdelements/flan pnpm add @sdelements/flan yarn add @sdelements/flan bun add @sdelements/flan ``` Provides the command `flan`. ## Health **Score 65/100 (B)** — status: active. Positive: has types; no vulnerabilities; recently updated; high maintenance score; high quality score. Warnings: low downloads; no esm support; pre 1.0. ## Facts | | | |---|---| | Version | 0.1.0-alpha.13 | | Published | 2026-10-22 | | First published | 2021-07-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=10.0.0 | | Dependencies | 10 | | Unpacked size | 54.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 182 | | Author | Houssam Haidar | | Maintainers | sibartlett, hhaidar, kmsunmin | | Keywords | database, postgres, dump | ## Links - npm: https://www.npmjs.com/package/@sdelements/flan - Repository: https://github.com/sdelements/flan - Issues: https://github.com/sdelements/flan/issues - npm.io page: https://npm.io/package/@sdelements/flan ## Dependencies (10) - [chalk](https://npm.io/package/chalk.md) ^4.1.1 - [execa](https://npm.io/package/execa.md) ^5.1.1 - [tslib](https://npm.io/package/tslib.md) ^1 - [cli-ux](https://npm.io/package/cli-ux.md) ^5.6.2 - [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3 - [@oclif/plugin-not-found](https://npm.io/package/@oclif/plugin-not-found.md) ^1.2.4 - [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.3.0 ## Recent versions - 0.1.0-alpha.13 (latest) — 2026-10-22 - 0.1.0-alpha.12 — 2026-04-02 - 0.1.0-alpha.11 — 2026-02-12 - 0.1.0-alpha.10 — 2021-09-27 - 0.1.0-alpha.9 — 2021-09-10 - 0.1.0-alpha.8 — 2021-08-30 - 0.1.0-alpha.7 — 2021-08-26 - 0.1.0-alpha.6 — 2021-08-13 - 0.1.0-alpha.5 — 2021-08-03 - 0.1.0-alpha.4 — 2021-08-03 - 0.1.0-alpha.3 — 2021-07-26 - 0.1.0-alpha.2 — 2021-07-26 - 0.1.0-alpha.1 — 2021-07-26 ## README

flan

A tasty tool that lets you save, load and share postgres snapshots with ease.

oclif Version Downloads/week License

# Usage ```sh-session $ npm install -g @sdelements/flan $ flan init running setup... $ flan save mydb@1.0.0 saving... $ flan load mydb@1.0.0 loading... $ flan publish mydb@1.0.0 publishing... $ flan available available snapshots... $ flan (-v|--version|version) @sdelements/flan/0.1.0-alpha.0 darwin-x64 node-v14.16.1 $ flan --help [COMMAND] USAGE $ flan COMMAND ... ``` # How it works Under the hood flan is a convenient wrapper for `pgdump` and `pgrestore`. It uses parallel jobs by default to ensure dumping/restoring your database is quick. Sharing database dumps is achieved by leveraging `git`. Essentially you push a tag to a repository of your choosing (defined in `flan.config.js`) and others can then pull it with `flan fetch`. We chose to use git because it fits well with our internal tooling and process but we understand it may not be the best solution for you. Pull requests are welcome if you're interested in using S3/Azure/etc as a store 🙂 > :warning: **WARNING**: Please don't use flan in situations where you can't afford data loss. # Commands * [`flan autocomplete [SHELL]`](#flan-autocomplete-shell) * [`flan available`](#flan-available) * [`flan delete DELETEFILE`](#flan-delete-deletefile) * [`flan fetch FILE`](#flan-fetch-file) * [`flan help [COMMAND]`](#flan-help-command) * [`flan init`](#flan-init) * [`flan list`](#flan-list) * [`flan load INPUT`](#flan-load-input) * [`flan publish FILE`](#flan-publish-file) * [`flan save OUTPUT`](#flan-save-output) * [`flan unpublish FILE`](#flan-unpublish-file) ## `flan autocomplete [SHELL]` display autocomplete installation instructions ``` USAGE $ flan autocomplete [SHELL] ARGUMENTS SHELL shell type OPTIONS -r, --refresh-cache Refresh cache (ignores displaying instructions) EXAMPLES $ flan autocomplete $ flan autocomplete bash $ flan autocomplete zsh $ flan autocomplete --refresh-cache ``` _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.3.0/src/commands/autocomplete/index.ts)_ ## `flan available` lists available dumps ``` USAGE $ flan available OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file -x, --extended show extra columns --columns=columns only show provided columns (comma-separated) --csv output is csv format [alias: --output=csv] --filter=filter filter property by partial string matching, ex: name=foo --no-header hide table header from output --no-truncate do not truncate output to fit screen --output=csv|json|yaml output in a more machine friendly format --sort=sort [default: tag] property to sort by (prepend '-' for descending) EXAMPLE $ flan available ``` _See code: [src/commands/available.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/available.ts)_ ## `flan delete DELETEFILE` delete a local database dump ``` USAGE $ flan delete DELETEFILE ARGUMENTS DELETEFILE name of file to delete OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLES $ flan delete myDB $ flan delete myDB@1.0.0 ``` _See code: [src/commands/delete.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/delete.ts)_ ## `flan fetch FILE` fetch specified dump file from a remote repository ``` USAGE $ flan fetch FILE ARGUMENTS FILE name of the file OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLE $ flan fetch filename ``` _See code: [src/commands/fetch.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/fetch.ts)_ ## `flan help [COMMAND]` display help for flan ``` USAGE $ flan help [COMMAND] ARGUMENTS COMMAND command to show help for OPTIONS --all see all commands in CLI ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_ ## `flan init` Initializes flan for this project ``` USAGE $ flan init OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file -y, --yes Auto confirm directory creating questions EXAMPLES $ flan init Config file found at home/flan.config.js $ flan init A config file will be created, continue? [y/n] $ flan init -c /some-folder/flan.config.json Config file found at home/flan/some-folder/flan.config.json $ flan init -y -c /some-folder/flan.config.json Config file found at /home/flan/some-folder/flan.config.json The base directory has been created successfully at /home/flan/some-folder/.flan The save directory has been created successfully at /home/flan/some-folder/.flan/local Git repository initialized at /home/flan/some-folder/.flan/repo ``` _See code: [src/commands/init.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/init.ts)_ ## `flan list` lists available dumps ``` USAGE $ flan list OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLE $ flan list ``` _See code: [src/commands/list.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/list.ts)_ ## `flan load INPUT` load database from dump ``` USAGE $ flan load INPUT ARGUMENTS INPUT name of input file OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file --drop-db Drops and re-creates the DB before restoring it's data --quiet Supress errors from pg_restore EXAMPLES $ flan load myDB $ flan load --drop-db --quiet myDB ``` _See code: [src/commands/load.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/load.ts)_ ## `flan publish FILE` publish specified dump file to a remote repository ``` USAGE $ flan publish FILE ARGUMENTS FILE name of the file OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLE $ flan publish filename ``` _See code: [src/commands/publish.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/publish.ts)_ ## `flan save OUTPUT` save current database to dump ``` USAGE $ flan save OUTPUT ARGUMENTS OUTPUT name of output file OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLE $ flan save myDB ``` _See code: [src/commands/save.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/save.ts)_ ## `flan unpublish FILE` unpublish specified database dump from a remote repository ``` USAGE $ flan unpublish FILE ARGUMENTS FILE name of the file OPTIONS -c, --config=config [default: ./flan.config.json] Path to configuration file EXAMPLE $ flan unpublish myDB@1.0.0 ``` _See code: [src/commands/unpublish.ts](https://github.com/sdelements/flan/blob/v0.1.0-alpha.13/src/commands/unpublish.ts)_

From Toronto with love ❤️

👩‍🍳 :pie: 👨‍🍳 :pie: 👩‍🍳 :pie: 👨‍🍳 :pie: 👨‍🍳
Built by Team Pie
Special thanks to @revangel for the logo

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