@microlink/cli/src/help.js

Interacting with Microlink API from your terminal.

'use strict'

const { gray, white } = require('./colors')

const code = str => `\`${str}\``

module.exports = `
${gray(`${white('microlink')} <url> [flags]`)}

Flags
  ${gray(
    `--api-key      authenticate using an API key (default is ${code(
      white('$MICROLINK_API_KEY')
    )}`
  )}
  ${gray(
    `--copy         copy output to clipboard (default is ${code(
      white('false')
    )}).`
  )}
  ${gray(
    `--json         print request & response payload as JSON (API key masked, default is ${code(
      white('false')
    )}).`
  )}
  ${gray(
    `--json-full    print request & response payload as JSON including full API key (default is ${code(
      white('false')
    )}).`
  )}
  ${gray(
    `--pretty       beauty response payload (default is ${code(
      white('true')
    )}).`
  )}
  ${gray('-H <header>    pass custom HTTP header to the request (repeatable).')}


Examples
  ${gray('microlink https://microlink.io&palette')}
  ${gray('microlink https://microlink.io&palette --no-pretty')}
  ${gray('microlink https://microlink.io&palette --json')}
  ${gray('microlink https://microlink.io&palette --json-full')}
  ${gray('microlink https://microlink.io&palette --api-key=MyApiKey')}
  ${gray("microlink https://example.com -H 'x-user-cookie: 1'")}
`