https://github.com/wanadev/obsidian-pack

Library and CLI tool to read and write the Obsidian Asset Package file format
https://github.com/wanadev/obsidian-pack

Last synced: about 2 months ago
JSON representation

Library and CLI tool to read and write the Obsidian Asset Package file format

• Host: GitHub
• URL: https://github.com/wanadev/obsidian-pack
• Owner: wanadev
• License: other
• Created: 2016-09-21T14:38:55.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-27T16:26:37.000Z (almost 5 years ago)
• Last Synced: 2025-01-22T12:45:43.728Z (3 months ago)
• Language: JavaScript
• Size: 837 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Obsidian Asset Package File Library

[![Build Status](https://travis-ci.org/wanadev/obsidian-pack.svg?branch=master)](https://travis-ci.org/wanadev/obsidian-pack)

[![NPM Version](http://img.shields.io/npm/v/obsidian-pack.svg?style=flat)](https://www.npmjs.com/package/obsidian-pack)

[![License](http://img.shields.io/npm/l/obsidian-pack.svg?style=flat)](https://github.com/wanadev/obsidian-pack/blob/master/LICENSE)

[![Dependencies](https://img.shields.io/david/wanadev/obsidian-pack.svg?maxAge=2592000)]()

[![Dev Dependencies](https://img.shields.io/david/dev/wanadev/obsidian-pack.svg?maxAge=2592000)]()

[![Greenkeeper badge](https://badges.greenkeeper.io/wanadev/obsidian-pack.svg)](https://greenkeeper.io/)

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

## CLI

### Get informations about the package

    obsidian-pack -d assets.opak

### Extract a package

    obsidian-pack -xf assets.opak [outputdir/]

### Create a package

    obsidian-pack -cf assets.opak [files]

    obsidian-pack -name org.example.pack.assets -cf assets.opak [files]

__NOTE:__ a file containing the `assetIndex` can be passed explicitly with the

`-i` options. It can also be listed with other files but must me named

`__assetindex__.json`.

### Help and other options

    obsidian-pack -h

## Tests

To lunch all tests, run the following command:

    npm test

## Changelog

* **1.0.2:** Updates dependencies

* **1.0.1:** Updates `uuid` dependency to 3.0.0

* **1.0.0:** Initial release