kikstart

• kikstart
• Usage
• Commands
• Credits
• License MIT

Usage

$ npm install -g kikstart
$ kikstart COMMAND
running command...
$ kikstart (-v|--version|version)
kikstart/1.6.1 darwin-x64 node-v12.14.1
$ kikstart --help [COMMAND]
USAGE
  $ kikstart COMMAND
...

Commands

• kikstart build
• kikstart config
• kikstart deploy
• kikstart dev
• kikstart find-proc
• kikstart help [COMMAND]
• kikstart init
• kikstart ping
• kikstart tunnel [PORT] [SUBDOMAIN]

kikstart build

Build a project

USAGE
  $ kikstart build

OPTIONS
  -c, --build-command=build-command  [default: yarn] Command used to build the project
  -d, --build-params=build-params    [default: build] Parameters used to build the project
  -p, --path=path                    (required) [default: .] Path to the project
  -v, --verbose                      Verbose output
  --help                             Show help

EXAMPLES
  ks build # build the project in the current folder
  ks build -p /workspace --build-command="npm" --build-params="run build --prod"

See code: src/commands/build.ts

kikstart config

describe the command here

USAGE
  $ kikstart config

OPTIONS
  -p, --path=path  (required) [default: .] Path to the project
  -v, --verbose    Verbose output
  --help           Show help

See code: src/commands/config.ts

kikstart deploy

Deploy a project

USAGE
  $ kikstart deploy

OPTIONS
  -b, --build                        Build before deploying
  -c, --build-command=build-command  [default: yarn] Command used to build the project
  -d, --build-params=build-params    [default: build] Parameters used to build the project
  -p, --path=path                    (required) [default: .] Path to the project
  -r, --target-repo=target-repo      Deployment target repo
  -t, --target=git                   Deployment target
  -v, --verbose                      Verbose output
  --help                             Show help

EXAMPLES
  ks deploy -p kikstart-ui-starter
  ks deploy --build -p kikstart-ui-starter # first trigger ks build

See code: src/commands/deploy.ts

kikstart dev

describe the command here

USAGE
  $ kikstart dev

OPTIONS
  -p, --path=path  (required) [default: .] Path to the project
  -v, --verbose    Verbose output
  --help           Show help

See code: src/commands/dev.ts

kikstart find-proc

Find a process based on the port/pid/name

USAGE
  $ kikstart find-proc

OPTIONS
  -i, --pid=pid    Process pid
  -n, --name=name  Process name
  -p, --port=port  Process port
  -v, --verbose    Verbose output
  --help           Show help

See code: src/commands/find-proc.ts

kikstart help [COMMAND]

display help for kikstart

USAGE
  $ kikstart help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

kikstart init

Initialize a new project

USAGE
  $ kikstart init

OPTIONS
  -c, --skip-config                        Skip config file generation.
  -d, --skip-install                       Skip dependency installation.
  -i, --installer=npm|yarn                 (required) [default: yarn] Package manager used to install dependencies

  -j, --installer-params=installer-params  (required) [default: --ignore-engines --prefer-offline --network-timeout
                                           10000] Parameters passed to the package manager

  -n, --no-cache                           Disable the cache for downloading templates

  -p, --path=path                          (required) [default: .] Path to the project

  -r, --remove-existing                    Delete the output dir if it exists.

  -s, --start                              Start project after initializing

  -t, --template-url=template-url          Url to the template, supports whatever

  -v, --verbose                            Verbose output

  -x, --start-script=start-script          [default: start] NPM script to start after initializing

  --help                                   Show help

EXAMPLES
  You can initialize and start a project by running:
  ks init -s
  This will create a kikstart config file, install the deps and start the project.

  For the template url you can use anything supported by degit (https://github.com/Rich-Harris/degit)
  ks init -p kikstart-ui-starter -t beeman/kikstart-ui-starter
  ks init -p nuxt-ts -t beeman/template-nuxt-ts --skip-install
  ks init -p /projects/angular-cli -t https://github.com/beeman/template-angular-cli

See code: src/commands/init.ts

kikstart ping

describe the command here

USAGE
  $ kikstart ping

OPTIONS
  -p, --path=path  (required) [default: .] Path to the project
  -v, --verbose    Verbose output
  --help           Show help

See code: src/commands/ping.ts

kikstart tunnel [PORT] [SUBDOMAIN]

Create a tunnel for a local port

USAGE
  $ kikstart tunnel [PORT] [SUBDOMAIN]

OPTIONS
  -h, --host=host  [default: http://kikstart.one] Host to use to create the tunnel.
  -v, --verbose    Verbose output
  --help           Show help

EXAMPLE
  ks tunnel 80 my-tunnel

See code: src/commands/tunnel.ts

Credits

• This projects containers a fork of bahmutov/deps-ok

  • MIT License, Copyright (c) 2013 Gleb Bahmutov

• This projects containers a fork of localtunnel/localtunnel

  • MIT License, Copyright (c) 2018 Roman Shtylman

License MIT