Interface Command

src/cli/command.ts:3–103

import { CommandOptions } from './legacy-command';

export interface Command {
  /**
   * Name of command with arguments:
   * <> for mandatory arguments.
   * [] for optional arguments.
   * e.g. 'add <path>'
   */
  name: string;

  /**
   * command alias (for example: 't' for 'tag')
   */
  alias?: string;

  /**
   * Description of the command in commands summery
   * `bit -h`
   * `bit`
   */
  shortDescription?: string;

  /**
   * The description of the command. Will be seen in bit command help.
   * `bit add --help`
   */
  description?: string;

  /**
   * allow grouping of commands to hint summery renderer
   * Places in default automatic help
   */
  group?: string;

  /**
   * should a command be exposed to the user.
   * e.g. experimental commands or commands created for the ssh communication should not be exposed
   */
  private?: boolean;

  /**
   * command that is not running on the terminal, such as "_fetch", "_put".
   * in case an error is thrown, it is serialized so it's easier to parse it later
   */
  internal?: boolean;

  /**
   * should turn on Loader
   */
  loader?: boolean;

  /**
   * Array of command options where each element is a tuple.
   * ['flag alias', 'flag name', 'flag description']
   * for example:
   * ['j', 'json', 'output json format']
   */
  options: CommandOptions;