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

beame-cli

v0.0.4

Published

Beame.io - common CLI handling

Downloads

3

Readme

Intro

This is CLI framework for Beame products. Currently it's in early stages so using it for your products is not advisable. We do expect that beame-cli will become usable to others as it matures. Documentation will be improved later.

Sample usage

const parametersSchema = {
	'format': {required: false, options: ['text', 'json'], default: 'text'},
};

const BeameCli = require('beame-cli');
const cli = new BeameCli('YOUR_SCRIPT_NAME_FOR_USAGE_EXAMPLES', 'DIR_WITH_FILES_FOR_CLI', [
	'NAMES_OF_FILES',
	'WITHOUT_DOT_JS'
]);

cli.setGlobalSchema(parametersSchema);

cli.approveCommand = (cmdName, subCmdName) => {
	if((cmdName == 'creds') && (subCmdName == 'getCreds')) {
		return true;
	}
	var credsCount = list().length;

	if (!credsCount) {
		console.log(getHelpMessage('no-certificates.txt'));
		return false;
	}
	return true;
};

cli.usage = () => {
	console.log(getHelpMessage('no-command.txt'));
};

cli.run();

DIR_WITH_FILES_FOR_CLI contents

There should be *.js files, each one containing functions to handle one sub-command.

...
function getCreds(regToken, callback) {
	callback
}

getCreds.params = { 'regToken': {required: true, base64: true, json: true} }
...

Sample output

./main.js
Usage:
  beame-gatekeeper creds getCreds --regToken regToken
  beame-gatekeeper creds list [--regex regex] [--format {text|json}]
  beame-gatekeeper creds createServersCredentials
  beame-gatekeeper creds webToken --type {config|admin|app} [--appId appId] [--format {text|json}]
  beame-gatekeeper config init
  beame-gatekeeper config name --name name
  beame-gatekeeper config setAuthServer --fqdn fqdn
  beame-gatekeeper config apps
  beame-gatekeeper server start