obsidian-file

Library and CLI tool to read and write the Obsidian Project file format

Usage no npm install needed!

<script type="module">
  import obsidianFile from 'https://cdn.skypack.dev/obsidian-file';
</script>

README

Obsidian Project File Library

Build Status NPM Version License Dependencies Dev Dependencies Greenkeeper badge

Library and CLI tool to read and write the Obsidian Project file format.

CLI

Get informations about a project file

obsidian-file -d project.wprj

Extract a project

obsidian-file -xf project.wprj [outputdir/]

Create a project

obsidian-file -cf project.wprj [files]
obsidian-file -t PROJTYPE -cf project.wprj [files]

NOTE: files containing metadata, project and blobIndex sections can be passed explicitly with the -m, -p and -i options, or can be listed with other files but must me named __metadata__.json, __project__.json and __blobindex__.json.

Help and other options

obsidian-file -h

Tests

To lunch all tests, run the following command:

npm test

Changelog

  • 3.0.0: Uses zlib instead of Pako to improve perfs (pako still used in browser when the module is built using Browserify). (#17)
  • 2.0.4: Updates dependencies
  • 2.0.3: Fixes documentation errors
  • 2.0.2: Updates cli dependencie
  • 2.0.1: Updates dependencies
  • 2.0.0: First public release