paparam

Strict and fair parameter papa

``
npm install paparam
`

Usage

$3

Use paparam to build a simple cli parser. Here is an example app invocation from the command line:

`bash
> app -i uuid-284h43j -b peer1 -b peer2 --storage /tmp/file/place link-32832uifsdjsfda
`

To handle this invocation, here is the paparam code

`js
import { header, summary, command, flag, arg } from 'paparam'
const cmd = command(
'run',
header('A simple example app'),
summary('Example app that uses a roomLink to join a room and do work.'),
arg('', 'the room link key'),
flag('--uuid|-i [uuid]', 'The specific schema uuid to use'),
flag('--user|-u [user]', 'The user name associated with the entry'),
flag('--storage|-s [storage]', 'Path to storage directory'),
flag('--blind|-b [blind]', 'Blind peer keys (can be specified multiple times)').multiple()
)
const program = cmd.parse() // default args: process.argv.slice(2)
if (program === null) throw new Error('missing arg')
console.log('user', program.flags.user)
console.log('storagePath', program.flags.storage || '/tmp')
console.log('blindPeers', program.flags.blind || [])
console.log('roomLink', program.roomLink)
cmd.add(flag('--another', 'lazy added'))
cmd.add({
'--more': 'via description object',
'--modifiers': ['are defined with array [desc, opts]', { multiple: true }]
})
cmd.parse(['-h'])
`

$3

Use paparam exports to compose commands together:

`js
const { header, footer, command, flag, arg, summary, description, rest } = require('./')
const run = command(
'run',
summary('Run an app from a link'),
description(
'Run an app from a file link (or path) or from a pear link.\nOptionally supply store for custom store path'
),
flag('--store|-s [path]', 'store path'),
arg('', 'link to run'),
rest('[...app-args]'),
() => console.log('ACTION ->', 'run', run.args.link, 'flags:', run.flags)
)
const cmd = command(
'pear',
summary('pear cli'),
{
// definition objects can also be used with form {[modifier ]: '' | ['', adjusters {...}]}:
'flag --log': 'log',
header: 'Welcome to the IoP'
},
header('Welcome to the IoP'),
footer('holepunch.to | pears.com | keet.io'),
run
)
cmd.parse(['--help']) // print pear help
cmd.parse(['run', '-h']) // print run help
cmd.parse(['run', '-s', '/path/to/store', 'pear://link']) // exec run command

run.add(flag('--pre-io', 'Show stdout & stderr of pre scripts')) // update command

cmd.parse(['run', '-s', '/path/to/store', '--pre-io', 'pear://link']) // exec run command
`

This should output:

`
Welcome to the IoP

pear [flags] [command]

pear cli

Flags:
--log log
--help|-h Show help

Commands:
run Run an app from a link

holepunch.to | pears.com | keet.io

Welcome to the IoP

pear run [flags] [...app-args]

Run an app from a link

Run an app from a file link (or path) or from a pear link.
Optionally supply store for custom store path

Arguments:
link to run
[...app-args]

Flags:
--store|-s [path] store path
--help|-h Show help

holepunch.to | pears.com | keet.io

ACTION -> run pear://link flags: { store: '/path/to/store', s: '/path/to/store', help: false, h: false }
ACTION -> run pear://link flags: {
store: '/path/to/store',
s: '/path/to/store',
help: false,
h: false,
preIo: true
}
`

API

$3

Defines a command with a specific behavior based on the supplied modifiers such as flags, arguments, and descriptions. This function is used to create the command object.

- Arguments:
- name : The name of the command.
- ...args | |