npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ochre

v0.1.0

Published

<p align="center"> <img src="ochre-small.jpg" /> </p>

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

perrymitchellperrymitchell

Keywords

Readme

Ochre

Resource packager and backup utility

About

Ochre (oh-kər) is a resource archival utility, designed to allow easy packaging, transferral and extraction of different types of resources. It was originally started as a machine backup system, but expanded to become a more broad-use tool.

Ochre is written entirely in JavaScript and is designed to run on NodeJS. Due to its heavy reliance on Node's fs module, it is not suitable for use within a browser.

Usage

Ochre should be installed globally and used as such:

npm install -g ochre

Depending on your operating system, the above command may need to be run with sudo.

Ochre does not support windows.

CLI

To get help using the command line tool, once installed, simply enter ochre --help.

Ochre supports 2 modes of operation: archiving and extraction.

# Archive some files defined in a configuration file
ochre config.ochre.json -a --output=myArchive.ochre

# Extract files from an archive
ochre myArchive.ochre -e

# Show help and other arguments
ochre --help

Ochre makes use of a configuration file to perform archiving of resources.

Disclaimer

Ochre comes with no guarantee for data safety or availability. Even when it becomes stable, it is at your own peril if you choose to use it to store sensitive data.

Development and contributing

The source directory holds the actual library, with index.js exposing the necessary methods for public consumption. cli.js in the root is used for the CLI executable. Tests are in the test directory.

To run the tests, simply execute npm test.

When contributing to Ochre, please make sure that you run all the necessary checks (with npm test) before making a PR. Most editors provide plugins to allow eslint to check your code as you go. If you add more functionality be sure to add covering tests.

An .editorconfig is also provided for easy configuration of supporting editors (such as Microsoft's VSCode). All contributions are expected to follow the same style as the rest of the project, and the editor configuration is designed to help with that.