Skip to content
/ cli Public

Command line interface helpers for LSK.js project creation

License

Notifications You must be signed in to change notification settings

lskjs/cli

Repository files navigation

LSK.js – CLI

LSK.js CLI (Command Line Interface) is the easiest way to create and manage LSK.js project.

LSK logo NPM version NPM downloads NPM Dependency count Have TypeScript types Have tree shaking NPM Package size License Ask us in Telegram

Quick start

$ npx lsk init test3
...waiting...
============= SUCCESS =============
now you should do: cd test3 && npm run dev

LSK.js – CLI

Usage

$ npm install -g @lskjs/cli
$ lsk COMMAND
running command...
$ lsk (-v|--version|version)
@lskjs/cli/3.0.0-alpha.6 darwin-arm64 node-v19.3.0
$ lsk --help [COMMAND]
USAGE
  $ lsk COMMAND
...

Commands

lsk bootstrap

USAGE
  $ lsk bootstrap

See code: lib/commands/bootstrap.js

lsk copy FROM TO

Recursive incremental copy dirs with rsync

USAGE
  $ lsk copy FROM TO

OPTIONS
  -g, --git=git                  include .git folder
  -n, --nodemodules=nodemodules  include node_modules folder

DESCRIPTION
  ...

See code: lib/commands/copy.js

lsk help [COMMAND]

Display help for lsk.

USAGE
  $ lsk help [COMMAND]

ARGUMENTS
  COMMAND  Command to show help for.

OPTIONS
  -n, --nested-commands  Include all nested commands in the output.

See code: @oclif/plugin-help

lsk info

USAGE
  $ lsk info

See code: lib/commands/info.js

lsk init PROJECTNAME

Init new LSK.js project

USAGE
  $ lsk init PROJECTNAME

OPTIONS
  -t, --template=template  An example to bootstrap the app with. You can use an example name from the LSK.js repo or a
                           GitHub URL. The URL can use any branch and/or subdirectory.

DESCRIPTION
  ...
  Extra documentation goes here

See code: lib/commands/init.js

lsk link FROM TO

Recursive watching and incremental copy dirs with rsync

USAGE
  $ lsk link FROM TO

OPTIONS
  -g, --git=git                  include .git folder
  -n, --nodemodules=nodemodules  include node_modules folder

DESCRIPTION
  ...

See code: lib/commands/link.js

lsk linkall CONFIG

Recursive watching and incremental copy dirs with rsync

USAGE
  $ lsk linkall CONFIG

OPTIONS
  -g, --git=git                  include .git folder
  -n, --nodemodules=nodemodules  include node_modules folder

DESCRIPTION
  ...

See code: lib/commands/linkall.js

lsk log

USAGE
  $ lsk log

See code: lib/commands/log.js

lsk run SCRIPT

USAGE
  $ lsk run SCRIPT

See code: lib/commands/run.js

lsk update

USAGE
  $ lsk update

See code: lib/commands/update.js

Contributors ✨


Igor Suvorov

💬 💻 🎨 📖 💡 🤔 👀 ⚠️ ️️️️♿️