learnpack
v0.1.28
Published
Seamlessly build or take interactive & auto-graded tutorials, start learning now or build a tutorial.
Downloads
1,261
Maintainers
Readme
learnpack
Create, sell or download and take learning amazing learning packages
Usage
$ npm install -g learnpack
$ learnpack COMMAND
running command...
$ learnpack (-v|--version|version)
learnpack/0.1.28 linux-x64 node-v17.6.0
$ learnpack --help [COMMAND]
USAGE
$ learnpack COMMAND
...
Commands
learnpack audit
learnpack clean
learnpack download [PACKAGE]
learnpack hello
learnpack help [COMMAND]
learnpack init
learnpack login [PACKAGE]
learnpack logout [PACKAGE]
learnpack plugins
learnpack plugins:install PLUGIN...
learnpack plugins:link PLUGIN
learnpack plugins:uninstall PLUGIN...
learnpack plugins:update
learnpack publish [PACKAGE]
learnpack start
learnpack test [EXERCISESLUG]
learnpack audit
Check if the configuration object has slug, description and repository property
USAGE
$ learnpack audit
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/audit.js
learnpack clean
Clean the configuration object
USAGE
$ learnpack clean
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/clean.js
learnpack download [PACKAGE]
Describe the command here
USAGE
$ learnpack download [PACKAGE]
ARGUMENTS
PACKAGE The unique string that identifies this package on learnpack
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/download.js
learnpack hello
Describe the command here
USAGE
$ learnpack hello
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/hello.js
learnpack help [COMMAND]
display help for learnpack
USAGE
$ learnpack help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
learnpack init
Create a new learning package: Book, Tutorial or Exercise
USAGE
$ learnpack init
OPTIONS
-h, --grading show CLI help
See code: src/commands/init.js
learnpack login [PACKAGE]
Describe the command here
USAGE
$ learnpack login [PACKAGE]
ARGUMENTS
PACKAGE The unique string that identifies this package on learnpack
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/login.js
learnpack logout [PACKAGE]
Describe the command here
USAGE
$ learnpack logout [PACKAGE]
ARGUMENTS
PACKAGE The unique string that identifies this package on learnpack
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/logout.js
learnpack plugins
list installed plugins
USAGE
$ learnpack plugins
OPTIONS
--core show core plugins
EXAMPLE
$ learnpack plugins
See code: @oclif/plugin-plugins
learnpack plugins:install PLUGIN...
installs a plugin into the CLI
USAGE
$ learnpack plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
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
$ learnpack plugins:add
EXAMPLES
$ learnpack plugins:install myplugin
$ learnpack plugins:install https://github.com/someuser/someplugin
$ learnpack plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
learnpack plugins:link PLUGIN
links a plugin into the CLI for development
USAGE
$ learnpack plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
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.
EXAMPLE
$ learnpack plugins:link myplugin
See code: @oclif/plugin-plugins
learnpack plugins:uninstall PLUGIN...
removes a plugin from the CLI
USAGE
$ learnpack plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ learnpack plugins:unlink
$ learnpack plugins:remove
See code: @oclif/plugin-plugins
learnpack plugins:update
update installed plugins
USAGE
$ learnpack plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
learnpack publish [PACKAGE]
Describe the command here
USAGE
$ learnpack publish [PACKAGE]
ARGUMENTS
PACKAGE The unique string that identifies this package on learnpack
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/publish.js
learnpack start
Runs a small server with all the exercise instructions
USAGE
$ learnpack start
OPTIONS
-d, --debug debugger mode for more verbage
-d, --disableGrading disble grading functionality
-g, --grading=isolated|incremental [isolated, incremental]
-h, --host=host server host
-m, --mode=standalone|preview Load a standalone editor or just the preview to be embeded in another editor:
Choices: [standalone, preview]
-p, --port=port server port
-v, --version=version E.g: 1.0.1
-w, --watch Watch for file changes
See code: src/commands/start.js
learnpack test [EXERCISESLUG]
Test exercises
USAGE
$ learnpack test [EXERCISESLUG]
ARGUMENTS
EXERCISESLUG The name of the exercise to test
See code: src/commands/test.js