LSK.js – CLI

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

• LSK.js – CLI
• Quick start
• Usage
• Commands

Quick start

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

Usage

$ npm install -g @lskjs/cli
$ lsk COMMAND
running command...
$ lsk (-v|--version|version)
@lskjs/cli/2.30.1 darwin-x64 node-v16.8.0
$ lsk --help [COMMAND]
USAGE
  $ lsk COMMAND
...

Commands

• lsk bootstrap
• lsk help [COMMAND]
• lsk info
• lsk init PROJECTNAME
• lsk link FROM TO
• lsk run SCRIPT
• lsk update

lsk bootstrap

USAGE
  $ lsk bootstrap

See code: src/commands/bootstrap.js

lsk help [COMMAND]

display help for lsk

USAGE
  $ lsk help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

lsk info

USAGE
  $ lsk info

See code: src/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: src/commands/init.js

lsk link FROM TO

Link npm packages and watch changes

USAGE
  $ lsk link FROM TO

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

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/link.js

lsk run SCRIPT

USAGE
  $ lsk run SCRIPT

OPTIONS
  -e, --explain=explain  explain of path

See code: src/commands/run.js

lsk update

USAGE
  $ lsk update

See code: src/commands/update.js

Contributors ✨

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