0.2.2 • Published 2 years ago
@langlangedu/cli v0.2.2
oclif-hello-world
oclif CLI
Usage
$ npm install -g @langlangedu/cli
$ langlang COMMAND
running command...
$ langlang (--version)
@langlangedu/cli/0.2.1 win32-x64 node-v14.19.1
$ langlang --help [COMMAND]
USAGE
$ langlang COMMAND
...
Commands
langlang config
langlang config set KEY [VALUE]
langlang course [FILE]
langlang course build
langlang course create NAME
langlang course pack [DIR]
langlang course run
langlang course template
langlang help [COMMAND]
langlang plugins
langlang plugins:install PLUGIN...
langlang plugins:inspect PLUGIN...
langlang plugins:install PLUGIN...
langlang plugins:link PLUGIN
langlang plugins:uninstall PLUGIN...
langlang plugins:uninstall PLUGIN...
langlang plugins:uninstall PLUGIN...
langlang plugins update
langlang pub CODE
langlang config
show config
USAGE
$ langlang config
DESCRIPTION
show config
EXAMPLES
$ langlang config
langlang config set KEY [VALUE]
set config
USAGE
$ langlang config set [KEY] [VALUE]
ARGUMENTS
KEY config key
VALUE config value
DESCRIPTION
set config
EXAMPLES
$ langlang config set key value
langlang course [FILE]
describe the command here
USAGE
$ langlang course [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ langlang course
langlang course build
build course
USAGE
$ langlang course build
DESCRIPTION
build course
EXAMPLES
$ langlang course build
langlang course create NAME
langlang create course dir
USAGE
$ langlang course create [NAME] -p <value> -l <value>
ARGUMENTS
NAME course dir name
FLAGS
-l, --level=<value> (required) course level
-p, --project=<value> (required) course project
DESCRIPTION
langlang create course dir
EXAMPLES
$ langlang course create
langlang course pack [DIR]
pack course offline
USAGE
$ langlang course pack [DIR] [-b <value>]
ARGUMENTS
DIR course dir
FLAGS
-b, --begin=<value> which course begin pack at
DESCRIPTION
pack course offline
EXAMPLES
$ langlang course pack
langlang course run
Run course with template
USAGE
$ langlang course run
DESCRIPTION
Run course with template
EXAMPLES
$ langlang course run
langlang course template
show template dir
USAGE
$ langlang course template
DESCRIPTION
show template dir
EXAMPLES
$ langlang course template
langlang help [COMMAND]
Display help for langlang.
USAGE
$ langlang help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for langlang.
See code: @oclif/plugin-help
langlang plugins
List installed plugins.
USAGE
$ langlang plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ langlang plugins
See code: @oclif/plugin-plugins
langlang plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ langlang plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ langlang plugins add
EXAMPLES
$ langlang plugins:install myplugin
$ langlang plugins:install https://github.com/someuser/someplugin
$ langlang plugins:install someuser/someplugin
langlang plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ langlang plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ langlang plugins:inspect myplugin
langlang plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ langlang plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ langlang plugins add
EXAMPLES
$ langlang plugins:install myplugin
$ langlang plugins:install https://github.com/someuser/someplugin
$ langlang plugins:install someuser/someplugin
langlang plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ langlang plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ langlang plugins:link myplugin
langlang plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ langlang plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ langlang plugins unlink
$ langlang plugins remove
langlang plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ langlang plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ langlang plugins unlink
$ langlang plugins remove
langlang plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ langlang plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ langlang plugins unlink
$ langlang plugins remove
langlang plugins update
Update installed plugins.
USAGE
$ langlang plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
langlang pub CODE
publish web online
USAGE
$ langlang pub [CODE] [-p <value>]
ARGUMENTS
CODE publish code
FLAGS
-p, --pos=<value> publish position
DESCRIPTION
publish web online
EXAMPLES
$ langlang pub xx_code
langlang config
show config
USAGE
$ langlang config
DESCRIPTION
show config
EXAMPLES
$ langlang config
langlang config set KEY [VALUE]
set config
USAGE
$ langlang config set [KEY] [VALUE]
ARGUMENTS
KEY config key
VALUE config value
DESCRIPTION
set config
EXAMPLES
$ langlang config set key value
langlang course [FILE]
describe the command here
USAGE
$ langlang course [FILE] [-n <value>] [-f]
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ langlang course
langlang course build
build course
USAGE
$ langlang course build
DESCRIPTION
build course
EXAMPLES
$ langlang course build
langlang course create NAME
langlang create course dir
USAGE
$ langlang course create [NAME] -p <value> -l <value>
ARGUMENTS
NAME course dir name
FLAGS
-l, --level=<value> (required) course level
-p, --project=<value> (required) course project
DESCRIPTION
langlang create course dir
EXAMPLES
$ langlang course create
langlang course pack [DIR]
pack course offline
USAGE
$ langlang course pack [DIR] [-b <value>]
ARGUMENTS
DIR course dir
FLAGS
-b, --begin=<value> which course begin pack at
DESCRIPTION
pack course offline
EXAMPLES
$ langlang course pack
langlang course run
Run course with template
USAGE
$ langlang course run
DESCRIPTION
Run course with template
EXAMPLES
$ langlang course run
langlang course template
show template dir
USAGE
$ langlang course template
DESCRIPTION
show template dir
EXAMPLES
$ langlang course template
langlang help [COMMAND]
Display help for langlang.
USAGE
$ langlang help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for langlang.
See code: @oclif/plugin-help