@types/command-line-usage

Defining Sections

This feature allows you to define different sections of the usage guide, such as headers and content. The code sample demonstrates how to create sections for a command-line application, including a header and options.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'My App',
    content: 'A brief description of my app.'
  },
  {
    header: 'Options',
    optionList: [
      {
        name: 'help',
        typeLabel: '{underline boolean}',
        description: 'Display this usage guide.'
      },
      {
        name: 'src',
        typeLabel: '{underline file}',
        description: 'The input files to process.'
      }
    ]
  }
];

const usage = commandLineUsage(sections);
console.log(usage);

Displaying Examples

This feature allows you to include examples in the usage guide. The code sample shows how to add an example section to the usage guide, demonstrating how to run the command-line application with specific options.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'Example',
    content: 'node myapp.js --src file.txt'
  }
];

const usage = commandLineUsage(sections);
console.log(usage);

Customizing Option Descriptions

This feature allows you to customize the descriptions and type labels for options. The code sample demonstrates how to define options with custom descriptions and type labels, providing more detailed information to the user.

const commandLineUsage = require('command-line-usage');

const sections = [
  {
    header: 'Options',
    optionList: [
      {
        name: 'verbose',
        description: 'Enable verbose mode.'
      },
      {
        name: 'timeout',
        typeLabel: '{underline ms}',
        description: 'Timeout value in milliseconds.'
      }
    ]
  }
];

const usage = commandLineUsage(sections);
console.log(usage);