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

quartermaster

v1.0.1

Published

quartermaster is a small library to create compressed binary packages for distribution

Downloads

4

Readme

q

A simplified package manager for mcp. Delivers directories with some meta information to a q-server and can download them again.

Upload and download is optimized to transfer binary diffs to a q-server.

WIP: This project is still work in progress. Basic operations pack/unpack/verify work fine but it has no command line interface yet

q requires a package name, description, version and files to include/exclude. This is defined in the q.manifest.

Install

npm install -g quartermaster

Command Line

q --help 

Api

q.manifest

A manifest is required for telling q what the package is contained in the package

Minimal Example: q.manifest

name: my-service
description: A little service that does not do much
version: 0.2.0

The preceding manifest describes a package called 'my-service' with version 0.2.0. It includes all files in the folder where q.manifest resides in.

By default all files matched by .gitignore are not included. If .gitignore excludes node_modules it might be sensible to include the node_modules folder explicitly using include: ['node_modules']

Defaults

Some fields in the manifest have defaults, so the example above could be rewritten as:

--- EMPTY FILE ---

name: defaults to value from package.json when present or the name of the exe (spaces replaces by '-')

description: defaults to value from package.json when present

version: defaults to the version in a package.json when present next to the manifest or to the FileVersion of the only exe in the root path of the module. If the example above contained exactly one EXE in build/Release it would take its version.

path: defaults to the manifest path.

Full example

name: my-module
description: A little module others can use
version: 2.0
path: .
include: ['node_modules']
dependencies:
    mcp-server-web: ~0.0.1
tags: ['web-module']
web-module:
    alias: ['client','download']
    auth: ip
    application: webapp
    api: yes
files:
    config: settings.yaml
    log: log.json

This manifest describes another module with some custom fields. The only fields relevant to q are description,version,path,include.

The other fields are custom fields users of the package can inspect. Usually the tags list is used to define types of packages and e.g. a package tagged with 'web-module' is usable by other packages.