learnpack

Create, sell or download and take learning amazing learning packages.

• learnpack
• Usage
• Commands

Usage

$ npm install -g @learnpack/learnpack
$ learnpack COMMAND
running command...
$ learnpack (-v|--version|version)
@learnpack/learnpack/5.0.3 win32-x64 node-v20.16.0
$ learnpack --help [COMMAND]
USAGE
  $ learnpack COMMAND
...

Commands

• learnpack audit
• learnpack clean
• learnpack download [PACKAGE]
• 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
• learnpack start
• learnpack test [EXERCISESLUG]

learnpack audit

learnpack audit is the command in charge of creating an auditory of the repository

USAGE
  $ learnpack audit

DESCRIPTION
  ...
  learnpack audit checks for the following information in a repository:
       1. The configuration object has slug, repository and description. (Error)
       2. The command learnpack clean has been run. (Error)
       3. If a markdown or test file doesn't have any content. (Error)
       4. The links are accessing to valid servers. (Error)
       5. The relative images are working (If they have the shortest path to the image or if the images exists in the 
  assets). (Error)
       6. The external images are working (If they are pointing to a valid server). (Error)
       7. The exercises directory names are valid. (Error)
       8. If an exercise doesn't have a README file. (Error)
       9. The exercises array (Of the config file) has content. (Error)
       10. The exercses have the same translations. (Warning)
       11. The .gitignore file exists. (Warning)
       12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)

See code: src\commands\audit.ts

learnpack clean

Clean the configuration object

USAGE
  $ learnpack clean

DESCRIPTION
  ...
     Extra documentation goes here

See code: src\commands\clean.ts

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.ts

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.ts

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.ts

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.ts

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

Builds the project by copying necessary files and directories into a zip file

USAGE
  $ learnpack publish

OPTIONS
  -h, --help  show CLI help

See code: src\commands\publish.ts

learnpack start

Runs a small server with all the exercise instructions

USAGE
  $ learnpack start

OPTIONS
  -D, --disableGrading                disble grading functionality
  -d, --debug                         debugger mode for more verbage
  -e, --editor=extension|preview      [preview, extension]
  -g, --grading=isolated|incremental  [isolated, incremental]
  -h, --host=host                     server host
  -p, --port=port                     server port
  -v, --version=version               E.g: 1.0.1
  -w, --watch                         Watch for file changes

See code: src\commands\start.ts

learnpack test [EXERCISESLUG]

Test exercises

USAGE
  $ learnpack test [EXERCISESLUG]

ARGUMENTS
  EXERCISESLUG  The name of the exercise to test

See code: src\commands\test.ts

0cb3e56d84c197f9d008836bb573eade212b7e57