ludd

ludd is The Luddites CLI Client To Install And Publish Dependencies.

yarn add ludd
npm i ludd

Table Of Contents

• Table Of Contents
• API
• async ludd(config: !Config): string
  • Config
• CLI
• Copyright & License

API

The package is available by importing its default function:

import ludd from 'ludd'

async ludd(  config: !Config,): string

The Luddites CLI Client To Install And Publish Dependencies.

• config* !Config: The config.

Config: Options for the program.

| Name | Type | Description | Default | | --------- | ---------------- | ----------------- | ------- | | shouldRun | boolean | A boolean option. | true | | text | string | A text to return. | - |

import ludd from 'ludd'

(async () => {
  const res = await ludd({
    text: 'example',
  })
  console.log(res)
})()

ludd called with example
example

CLI

The package can also be used from the CLI.

The Luddites CLI Client To Install And Publish Dependencies.

  ludd input [-o output] [-ihv]

	input        	The path to the input file.
	--output, -o 	Where to save the output. By default prints to stdout.
	             	Default: -.
	--init, -i   	Initialise in the current folder.
	--help, -h   	Print the help information and exit.
	--version, -v	Show the version's number and exit.

  Example:

    ludd example.txt -o out.txt

Copyright & License

GNU Affero General Public License v3.0