Function kickstart

  • kickstart(options?): Promise<void>

  • kickstarts a SGRUD-based project using simple-git.

    Description
  Kickstarts a SGRUD-based project using `simple-git`

Usage
  $ sgrud kickstart [library] [options]

Options
  --prefix      Use an alternative working directory  (default ./)
  -h, --help    Displays this message

Examples
  $ sgrud kickstart # Run with default options
  $ sgrud kickstart preact --prefix ./module # Kickstart preact in ./module

    Parameters

    • options: {
          library?: string;
          prefix?: string;
      } = {}

      The options object.

      • Optional library?: string

        Library which to base upon.

        Default Value

        'sgrud'

      • Optional prefix?: string

        Use an alternative working directory.

        Default Value

        './'

    Returns Promise<void>

    An execution Promise.

    Example

    Run with default options:

    require('@sgrud/bin');

    sgrud.bin.kickstart();

    Example

    kickstart preact in ./module:

    require('@sgrud/bin');

    sgrud.bin.kickstart({
      prefix: './module',
      library: 'preact'
    });

Settings

Member Visibility

Theme

Generated using TypeDoc