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

configami

v1.1.4

Published

Configuration File Origami

Downloads

12

Readme

WIP WARNING (THIS IS INCOMPLETE, AND NOT PROPERLY DOCUMENTED - YOU BEEN WARNED)


Configami

  • Configuration
  • Origami

A Configuration and templating CLI tool, designed specifically for the use case of config management. This is designed to be used in conjuncture of other tools such as bash, ansible, and terraform.

Allow the generation of extreamly large YAML files, from a few simple lines and a good template.

Example image of configami in action

The name is a shorten form of "Configuration Origami"


Getting started

To install configami via npm use

npm install -g configami

Workspace folder structure

A Configami workspace would consist of the following sub folders.

  • TEMPLATE : Where templates would be searched and used
  • WORKSPACE : Where your generated working files would be (eg. terraform/yaml/bash files)

This folder will also be the context where the project is executed from, as such package.json and node_modules in here will be used as well.

In addition temporary caching folders may be generated under

  • .configami_cache

Primary use case

Its main goal is to tackle the problem of large 1000+ lines of configuration files, needing to be managed in a "modern" cloud setup (ie: kubernetes, terraform). With a very small team.

This works by templatising the config file generation process.

Example templates

https://github.com/uilicious/configami-k8-template

Limitations

This assumes a secure environment

If you want complex user permission schema to individual config files, it is not a current goal of this project.

This is not a frontend templating engine

While it is possible to generate static sites using this CLI, this is not what it was designed for. That being said, nothing stops you from doing so (lol)