@learnpack/learnpack 5.0.275 → 5.0.276

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/README.md +409 -409
  2. package/lib/commands/audit.js +15 -15
  3. package/lib/commands/breakToken.js +19 -19
  4. package/lib/commands/clean.js +3 -3
  5. package/lib/commands/init.js +41 -41
  6. package/lib/commands/logout.js +3 -3
  7. package/lib/commands/publish.js +5 -10
  8. package/lib/commands/serve.js +3 -2
  9. package/lib/creatorDist/assets/index-BfLyIQVh.js +10343 -10224
  10. package/lib/managers/config/index.js +77 -77
  11. package/lib/utils/api.d.ts +1 -1
  12. package/lib/utils/api.js +12 -9
  13. package/lib/utils/creatorUtilities.js +14 -14
  14. package/package.json +1 -1
  15. package/src/commands/audit.ts +487 -487
  16. package/src/commands/breakToken.ts +67 -67
  17. package/src/commands/clean.ts +30 -30
  18. package/src/commands/init.ts +650 -650
  19. package/src/commands/logout.ts +38 -38
  20. package/src/commands/publish.ts +20 -25
  21. package/src/commands/serve.ts +8 -3
  22. package/src/commands/start.ts +333 -333
  23. package/src/commands/translate.ts +123 -123
  24. package/src/creator/README.md +54 -54
  25. package/src/creator/eslint.config.js +28 -28
  26. package/src/creator/src/components/syllabus/ContentIndex.tsx +312 -312
  27. package/src/creator/src/i18n.ts +28 -28
  28. package/src/creator/src/index.css +217 -217
  29. package/src/creator/src/locales/en.json +126 -126
  30. package/src/creator/src/locales/es.json +126 -126
  31. package/src/creator/src/utils/configTypes.ts +122 -122
  32. package/src/creator/src/utils/constants.ts +13 -13
  33. package/src/creator/src/utils/creatorUtils.ts +46 -46
  34. package/src/creator/src/utils/eventBus.ts +2 -2
  35. package/src/creator/src/utils/lib.ts +468 -468
  36. package/src/creator/src/utils/socket.ts +61 -61
  37. package/src/creator/src/utils/store.ts +222 -222
  38. package/src/creator/src/vite-env.d.ts +1 -1
  39. package/src/creator/vite.config.ts +13 -13
  40. package/src/creatorDist/assets/index-BfLyIQVh.js +10343 -10224
  41. package/src/managers/config/defaults.ts +49 -49
  42. package/src/managers/config/exercise.ts +364 -364
  43. package/src/managers/config/index.ts +775 -775
  44. package/src/managers/file.ts +236 -236
  45. package/src/managers/server/routes.ts +554 -554
  46. package/src/managers/session.ts +182 -182
  47. package/src/managers/telemetry.ts +188 -188
  48. package/src/models/action.ts +13 -13
  49. package/src/models/config-manager.ts +28 -28
  50. package/src/models/config.ts +106 -106
  51. package/src/models/creator.ts +47 -47
  52. package/src/models/exercise-obj.ts +30 -30
  53. package/src/models/session.ts +39 -39
  54. package/src/models/socket.ts +61 -61
  55. package/src/models/status.ts +16 -16
  56. package/src/ui/_app/app.css +1 -1
  57. package/src/ui/_app/app.js +366 -363
  58. package/src/ui/app.tar.gz +0 -0
  59. package/src/utils/BaseCommand.ts +56 -56
  60. package/src/utils/api.ts +53 -39
  61. package/src/utils/audit.ts +392 -392
  62. package/src/utils/checkNotInstalled.ts +267 -267
  63. package/src/utils/configBuilder.ts +82 -82
  64. package/src/utils/convertCreds.js +34 -34
  65. package/src/utils/creatorUtilities.ts +504 -504
  66. package/src/utils/incrementVersion.js +74 -74
  67. package/src/utils/misc.ts +58 -58
  68. package/src/utils/rigoActions.ts +500 -500
  69. package/src/utils/sidebarGenerator.ts +195 -195
  70. package/src/utils/templates/isolated/exercises/01-hello-world/README.es.md +26 -26
  71. package/src/utils/templates/isolated/exercises/01-hello-world/README.md +26 -26
package/README.md CHANGED
@@ -1,409 +1,409 @@
1
- # learnpack
2
-
3
- Create, sell or download and take learning amazing learning packages.
4
-
5
- [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
6
- [![Version](https://img.shields.io/npm/v/learnpack.svg)](https://npmjs.org/package/learnpack)
7
- [![Downloads/week](https://img.shields.io/npm/dw/learnpack.svg)](https://npmjs.org/package/learnpack)
8
- [![License](https://img.shields.io/npm/l/learnpack.svg)](https://github.com/learnpack/learnpack-cli/blob/master/package.json)
9
-
10
- <!-- toc -->
11
-
12
- - [learnpack](#learnpack)
13
- - [Usage](#usage)
14
- - [Commands](#commands)
15
- <!-- tocstop -->
16
-
17
- # Usage
18
-
19
- <!-- usage -->
20
-
21
- ```sh-session
22
- $ npm install -g @learnpack/learnpack
23
- $ learnpack COMMAND
24
- running command...
25
- $ learnpack (-v|--version|version)
26
- @learnpack/learnpack/5.0.217 win32-x64 node-v22.15.0
27
- $ learnpack --help [COMMAND]
28
- USAGE
29
- $ learnpack COMMAND
30
- ...
31
- ```
32
-
33
- <!-- usagestop -->
34
-
35
- # Commands
36
-
37
- <!-- commands -->
38
-
39
- - [`learnpack audit`](#learnpack-audit)
40
- - [`learnpack breakToken`](#learnpack-breaktoken)
41
- - [`learnpack clean`](#learnpack-clean)
42
- - [`learnpack download [PACKAGE]`](#learnpack-download-package)
43
- - [`learnpack help [COMMAND]`](#learnpack-help-command)
44
- - [`learnpack init`](#learnpack-init)
45
- - [`learnpack login [PACKAGE]`](#learnpack-login-package)
46
- - [`learnpack logout [PACKAGE]`](#learnpack-logout-package)
47
- - [`learnpack plugins`](#learnpack-plugins)
48
- - [`learnpack plugins:install PLUGIN...`](#learnpack-pluginsinstall-plugin)
49
- - [`learnpack plugins:link PLUGIN`](#learnpack-pluginslink-plugin)
50
- - [`learnpack plugins:uninstall PLUGIN...`](#learnpack-pluginsuninstall-plugin)
51
- - [`learnpack plugins:update`](#learnpack-pluginsupdate)
52
- - [`learnpack publish`](#learnpack-publish)
53
- - [`learnpack serve`](#learnpack-serve)
54
- - [`learnpack start`](#learnpack-start)
55
- - [`learnpack test [EXERCISESLUG]`](#learnpack-test-exerciseslug)
56
- - [`learnpack translate`](#learnpack-translate)
57
-
58
- ## `learnpack audit`
59
-
60
- learnpack audit is the command in charge of creating an auditory of the repository
61
-
62
- ```
63
- USAGE
64
- $ learnpack audit
65
-
66
- OPTIONS
67
- -s, --strict strict mode
68
-
69
- DESCRIPTION
70
- ...
71
- learnpack audit checks for the following information in a repository:
72
- 1. The configuration object has slug, repository and description. (Error)
73
- 2. The command learnpack clean has been run. (Error)
74
- 3. If a markdown or test file doesn't have any content. (Error)
75
- 4. The links are accessing to valid servers. (Error)
76
- 5. The relative images are working (If they have the shortest path to the image or if the images exists in the
77
- assets). (Error)
78
- 6. The external images are working (If they are pointing to a valid server). (Error)
79
- 7. The exercises directory names are valid. (Error)
80
- 8. If an exercise doesn't have a README file. (Error)
81
- 9. The exercises array (Of the config file) has content. (Error)
82
- 10. The exercses have the same translations. (Warning)
83
- 11. The .gitignore file exists. (Warning)
84
- 12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
85
- ```
86
-
87
- _See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\audit.ts)_
88
-
89
- ## `learnpack breakToken`
90
-
91
- Break the token
92
-
93
- ```
94
- USAGE
95
- $ learnpack breakToken
96
-
97
- OPTIONS
98
- -h, --grading show CLI help
99
- -y, --yes Skip all prompts and initialize an empty project
100
- ```
101
-
102
- _See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\breakToken.ts)_
103
-
104
- ## `learnpack clean`
105
-
106
- Clean the configuration object
107
-
108
- ```
109
- USAGE
110
- $ learnpack clean
111
-
112
- DESCRIPTION
113
- ...
114
- Extra documentation goes here
115
- ```
116
-
117
- _See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\clean.ts)_
118
-
119
- ## `learnpack download [PACKAGE]`
120
-
121
- Describe the command here
122
-
123
- ```
124
- USAGE
125
- $ learnpack download [PACKAGE]
126
-
127
- ARGUMENTS
128
- PACKAGE The unique string that identifies this package on learnpack
129
-
130
- DESCRIPTION
131
- ...
132
- Extra documentation goes here
133
- ```
134
-
135
- _See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\download.ts)_
136
-
137
- ## `learnpack help [COMMAND]`
138
-
139
- display help for learnpack
140
-
141
- ```
142
- USAGE
143
- $ learnpack help [COMMAND]
144
-
145
- ARGUMENTS
146
- COMMAND command to show help for
147
-
148
- OPTIONS
149
- --all see all commands in CLI
150
- ```
151
-
152
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src\commands\help.ts)_
153
-
154
- ## `learnpack init`
155
-
156
- Create a new learning package: Book, Tutorial or Exercise
157
-
158
- ```
159
- USAGE
160
- $ learnpack init
161
-
162
- OPTIONS
163
- -h, --grading show CLI help
164
- -y, --yes Skip all prompts and initialize an empty project
165
- ```
166
-
167
- _See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\init.ts)_
168
-
169
- ## `learnpack login [PACKAGE]`
170
-
171
- Describe the command here
172
-
173
- ```
174
- USAGE
175
- $ learnpack login [PACKAGE]
176
-
177
- ARGUMENTS
178
- PACKAGE The unique string that identifies this package on learnpack
179
-
180
- DESCRIPTION
181
- ...
182
- Extra documentation goes here
183
- ```
184
-
185
- _See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\login.ts)_
186
-
187
- ## `learnpack logout [PACKAGE]`
188
-
189
- Describe the command here
190
-
191
- ```
192
- USAGE
193
- $ learnpack logout [PACKAGE]
194
-
195
- ARGUMENTS
196
- PACKAGE The unique string that identifies this package on learnpack
197
-
198
- DESCRIPTION
199
- ...
200
- Extra documentation goes here
201
- ```
202
-
203
- _See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\logout.ts)_
204
-
205
- ## `learnpack plugins`
206
-
207
- list installed plugins
208
-
209
- ```
210
- USAGE
211
- $ learnpack plugins
212
-
213
- OPTIONS
214
- --core show core plugins
215
-
216
- EXAMPLE
217
- $ learnpack plugins
218
- ```
219
-
220
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\index.ts)_
221
-
222
- ## `learnpack plugins:install PLUGIN...`
223
-
224
- installs a plugin into the CLI
225
-
226
- ```
227
- USAGE
228
- $ learnpack plugins:install PLUGIN...
229
-
230
- ARGUMENTS
231
- PLUGIN plugin to install
232
-
233
- OPTIONS
234
- -f, --force yarn install with force flag
235
- -h, --help show CLI help
236
- -v, --verbose
237
-
238
- DESCRIPTION
239
- Can be installed from npm or a git url.
240
-
241
- Installation of a user-installed plugin will override a core plugin.
242
-
243
- e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
244
- will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
245
- the CLI without the need to patch and update the whole CLI.
246
-
247
- ALIASES
248
- $ learnpack plugins:add
249
-
250
- EXAMPLES
251
- $ learnpack plugins:install myplugin
252
- $ learnpack plugins:install https://github.com/someuser/someplugin
253
- $ learnpack plugins:install someuser/someplugin
254
- ```
255
-
256
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\install.ts)_
257
-
258
- ## `learnpack plugins:link PLUGIN`
259
-
260
- links a plugin into the CLI for development
261
-
262
- ```
263
- USAGE
264
- $ learnpack plugins:link PLUGIN
265
-
266
- ARGUMENTS
267
- PATH [default: .] path to plugin
268
-
269
- OPTIONS
270
- -h, --help show CLI help
271
- -v, --verbose
272
-
273
- DESCRIPTION
274
- Installation of a linked plugin will override a user-installed or core plugin.
275
-
276
- e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
277
- command will override the user-installed or core plugin implementation. This is useful for development work.
278
-
279
- EXAMPLE
280
- $ learnpack plugins:link myplugin
281
- ```
282
-
283
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\link.ts)_
284
-
285
- ## `learnpack plugins:uninstall PLUGIN...`
286
-
287
- removes a plugin from the CLI
288
-
289
- ```
290
- USAGE
291
- $ learnpack plugins:uninstall PLUGIN...
292
-
293
- ARGUMENTS
294
- PLUGIN plugin to uninstall
295
-
296
- OPTIONS
297
- -h, --help show CLI help
298
- -v, --verbose
299
-
300
- ALIASES
301
- $ learnpack plugins:unlink
302
- $ learnpack plugins:remove
303
- ```
304
-
305
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\uninstall.ts)_
306
-
307
- ## `learnpack plugins:update`
308
-
309
- update installed plugins
310
-
311
- ```
312
- USAGE
313
- $ learnpack plugins:update
314
-
315
- OPTIONS
316
- -h, --help show CLI help
317
- -v, --verbose
318
- ```
319
-
320
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\update.ts)_
321
-
322
- ## `learnpack publish`
323
-
324
- Builds the project by copying necessary files and directories into a zip file
325
-
326
- ```
327
- USAGE
328
- $ learnpack publish
329
-
330
- OPTIONS
331
- -h, --help show CLI help
332
- -s, --strict strict mode
333
- ```
334
-
335
- _See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\publish.ts)_
336
-
337
- ## `learnpack serve`
338
-
339
- Runs a small server to build tutorials
340
-
341
- ```
342
- USAGE
343
- $ learnpack serve
344
-
345
- OPTIONS
346
- -d, --debug debugger mode for more verbage
347
- -h, --host=host server host
348
- -p, --port=port server port
349
- -y, --yes Skip all prompts and initialize an empty project
350
- ```
351
-
352
- _See code: [src\commands\serve.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\serve.ts)_
353
-
354
- ## `learnpack start`
355
-
356
- Runs a small server with all the exercise instructions
357
-
358
- ```
359
- USAGE
360
- $ learnpack start
361
-
362
- OPTIONS
363
- -D, --disableGrading disble grading functionality
364
- -d, --debug debugger mode for more verbage
365
- -e, --editor=extension|preview [preview, extension]
366
- -g, --grading=isolated|incremental [isolated, incremental]
367
- -h, --host=host server host
368
- -p, --port=port server port
369
- -v, --version=version E.g: 1.0.1
370
- -w, --watch Watch for file changes
371
- -y, --yes Skip all prompts and initialize an empty project
372
- ```
373
-
374
- _See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\start.ts)_
375
-
376
- ## `learnpack test [EXERCISESLUG]`
377
-
378
- Test exercises
379
-
380
- ```
381
- USAGE
382
- $ learnpack test [EXERCISESLUG]
383
-
384
- ARGUMENTS
385
- EXERCISESLUG The name of the exercise to test
386
-
387
- OPTIONS
388
- -y, --yes Skip all prompts and initialize an empty project
389
- ```
390
-
391
- _See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\test.ts)_
392
-
393
- ## `learnpack translate`
394
-
395
- List all the lessons, the user is able of select many of them to translate to the given languages
396
-
397
- ```
398
- USAGE
399
- $ learnpack translate
400
-
401
- OPTIONS
402
- -y, --yes Skip all prompts and initialize an empty project
403
- ```
404
-
405
- _See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\translate.ts)_
406
-
407
- <!-- commandsstop -->
408
-
409
- > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57
1
+ # learnpack
2
+
3
+ Create, sell or download and take learning amazing learning packages.
4
+
5
+ [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
6
+ [![Version](https://img.shields.io/npm/v/learnpack.svg)](https://npmjs.org/package/learnpack)
7
+ [![Downloads/week](https://img.shields.io/npm/dw/learnpack.svg)](https://npmjs.org/package/learnpack)
8
+ [![License](https://img.shields.io/npm/l/learnpack.svg)](https://github.com/learnpack/learnpack-cli/blob/master/package.json)
9
+
10
+ <!-- toc -->
11
+
12
+ - [learnpack](#learnpack)
13
+ - [Usage](#usage)
14
+ - [Commands](#commands)
15
+ <!-- tocstop -->
16
+
17
+ # Usage
18
+
19
+ <!-- usage -->
20
+
21
+ ```sh-session
22
+ $ npm install -g @learnpack/learnpack
23
+ $ learnpack COMMAND
24
+ running command...
25
+ $ learnpack (-v|--version|version)
26
+ @learnpack/learnpack/5.0.217 win32-x64 node-v22.15.0
27
+ $ learnpack --help [COMMAND]
28
+ USAGE
29
+ $ learnpack COMMAND
30
+ ...
31
+ ```
32
+
33
+ <!-- usagestop -->
34
+
35
+ # Commands
36
+
37
+ <!-- commands -->
38
+
39
+ - [`learnpack audit`](#learnpack-audit)
40
+ - [`learnpack breakToken`](#learnpack-breaktoken)
41
+ - [`learnpack clean`](#learnpack-clean)
42
+ - [`learnpack download [PACKAGE]`](#learnpack-download-package)
43
+ - [`learnpack help [COMMAND]`](#learnpack-help-command)
44
+ - [`learnpack init`](#learnpack-init)
45
+ - [`learnpack login [PACKAGE]`](#learnpack-login-package)
46
+ - [`learnpack logout [PACKAGE]`](#learnpack-logout-package)
47
+ - [`learnpack plugins`](#learnpack-plugins)
48
+ - [`learnpack plugins:install PLUGIN...`](#learnpack-pluginsinstall-plugin)
49
+ - [`learnpack plugins:link PLUGIN`](#learnpack-pluginslink-plugin)
50
+ - [`learnpack plugins:uninstall PLUGIN...`](#learnpack-pluginsuninstall-plugin)
51
+ - [`learnpack plugins:update`](#learnpack-pluginsupdate)
52
+ - [`learnpack publish`](#learnpack-publish)
53
+ - [`learnpack serve`](#learnpack-serve)
54
+ - [`learnpack start`](#learnpack-start)
55
+ - [`learnpack test [EXERCISESLUG]`](#learnpack-test-exerciseslug)
56
+ - [`learnpack translate`](#learnpack-translate)
57
+
58
+ ## `learnpack audit`
59
+
60
+ learnpack audit is the command in charge of creating an auditory of the repository
61
+
62
+ ```
63
+ USAGE
64
+ $ learnpack audit
65
+
66
+ OPTIONS
67
+ -s, --strict strict mode
68
+
69
+ DESCRIPTION
70
+ ...
71
+ learnpack audit checks for the following information in a repository:
72
+ 1. The configuration object has slug, repository and description. (Error)
73
+ 2. The command learnpack clean has been run. (Error)
74
+ 3. If a markdown or test file doesn't have any content. (Error)
75
+ 4. The links are accessing to valid servers. (Error)
76
+ 5. The relative images are working (If they have the shortest path to the image or if the images exists in the
77
+ assets). (Error)
78
+ 6. The external images are working (If they are pointing to a valid server). (Error)
79
+ 7. The exercises directory names are valid. (Error)
80
+ 8. If an exercise doesn't have a README file. (Error)
81
+ 9. The exercises array (Of the config file) has content. (Error)
82
+ 10. The exercses have the same translations. (Warning)
83
+ 11. The .gitignore file exists. (Warning)
84
+ 12. If there is a file within the exercises folder but not inside of any particular exercise's folder. (Warning)
85
+ ```
86
+
87
+ _See code: [src\commands\audit.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\audit.ts)_
88
+
89
+ ## `learnpack breakToken`
90
+
91
+ Break the token
92
+
93
+ ```
94
+ USAGE
95
+ $ learnpack breakToken
96
+
97
+ OPTIONS
98
+ -h, --grading show CLI help
99
+ -y, --yes Skip all prompts and initialize an empty project
100
+ ```
101
+
102
+ _See code: [src\commands\breakToken.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\breakToken.ts)_
103
+
104
+ ## `learnpack clean`
105
+
106
+ Clean the configuration object
107
+
108
+ ```
109
+ USAGE
110
+ $ learnpack clean
111
+
112
+ DESCRIPTION
113
+ ...
114
+ Extra documentation goes here
115
+ ```
116
+
117
+ _See code: [src\commands\clean.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\clean.ts)_
118
+
119
+ ## `learnpack download [PACKAGE]`
120
+
121
+ Describe the command here
122
+
123
+ ```
124
+ USAGE
125
+ $ learnpack download [PACKAGE]
126
+
127
+ ARGUMENTS
128
+ PACKAGE The unique string that identifies this package on learnpack
129
+
130
+ DESCRIPTION
131
+ ...
132
+ Extra documentation goes here
133
+ ```
134
+
135
+ _See code: [src\commands\download.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\download.ts)_
136
+
137
+ ## `learnpack help [COMMAND]`
138
+
139
+ display help for learnpack
140
+
141
+ ```
142
+ USAGE
143
+ $ learnpack help [COMMAND]
144
+
145
+ ARGUMENTS
146
+ COMMAND command to show help for
147
+
148
+ OPTIONS
149
+ --all see all commands in CLI
150
+ ```
151
+
152
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src\commands\help.ts)_
153
+
154
+ ## `learnpack init`
155
+
156
+ Create a new learning package: Book, Tutorial or Exercise
157
+
158
+ ```
159
+ USAGE
160
+ $ learnpack init
161
+
162
+ OPTIONS
163
+ -h, --grading show CLI help
164
+ -y, --yes Skip all prompts and initialize an empty project
165
+ ```
166
+
167
+ _See code: [src\commands\init.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\init.ts)_
168
+
169
+ ## `learnpack login [PACKAGE]`
170
+
171
+ Describe the command here
172
+
173
+ ```
174
+ USAGE
175
+ $ learnpack login [PACKAGE]
176
+
177
+ ARGUMENTS
178
+ PACKAGE The unique string that identifies this package on learnpack
179
+
180
+ DESCRIPTION
181
+ ...
182
+ Extra documentation goes here
183
+ ```
184
+
185
+ _See code: [src\commands\login.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\login.ts)_
186
+
187
+ ## `learnpack logout [PACKAGE]`
188
+
189
+ Describe the command here
190
+
191
+ ```
192
+ USAGE
193
+ $ learnpack logout [PACKAGE]
194
+
195
+ ARGUMENTS
196
+ PACKAGE The unique string that identifies this package on learnpack
197
+
198
+ DESCRIPTION
199
+ ...
200
+ Extra documentation goes here
201
+ ```
202
+
203
+ _See code: [src\commands\logout.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\logout.ts)_
204
+
205
+ ## `learnpack plugins`
206
+
207
+ list installed plugins
208
+
209
+ ```
210
+ USAGE
211
+ $ learnpack plugins
212
+
213
+ OPTIONS
214
+ --core show core plugins
215
+
216
+ EXAMPLE
217
+ $ learnpack plugins
218
+ ```
219
+
220
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\index.ts)_
221
+
222
+ ## `learnpack plugins:install PLUGIN...`
223
+
224
+ installs a plugin into the CLI
225
+
226
+ ```
227
+ USAGE
228
+ $ learnpack plugins:install PLUGIN...
229
+
230
+ ARGUMENTS
231
+ PLUGIN plugin to install
232
+
233
+ OPTIONS
234
+ -f, --force yarn install with force flag
235
+ -h, --help show CLI help
236
+ -v, --verbose
237
+
238
+ DESCRIPTION
239
+ Can be installed from npm or a git url.
240
+
241
+ Installation of a user-installed plugin will override a core plugin.
242
+
243
+ e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
244
+ will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
245
+ the CLI without the need to patch and update the whole CLI.
246
+
247
+ ALIASES
248
+ $ learnpack plugins:add
249
+
250
+ EXAMPLES
251
+ $ learnpack plugins:install myplugin
252
+ $ learnpack plugins:install https://github.com/someuser/someplugin
253
+ $ learnpack plugins:install someuser/someplugin
254
+ ```
255
+
256
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\install.ts)_
257
+
258
+ ## `learnpack plugins:link PLUGIN`
259
+
260
+ links a plugin into the CLI for development
261
+
262
+ ```
263
+ USAGE
264
+ $ learnpack plugins:link PLUGIN
265
+
266
+ ARGUMENTS
267
+ PATH [default: .] path to plugin
268
+
269
+ OPTIONS
270
+ -h, --help show CLI help
271
+ -v, --verbose
272
+
273
+ DESCRIPTION
274
+ Installation of a linked plugin will override a user-installed or core plugin.
275
+
276
+ e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
277
+ command will override the user-installed or core plugin implementation. This is useful for development work.
278
+
279
+ EXAMPLE
280
+ $ learnpack plugins:link myplugin
281
+ ```
282
+
283
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\link.ts)_
284
+
285
+ ## `learnpack plugins:uninstall PLUGIN...`
286
+
287
+ removes a plugin from the CLI
288
+
289
+ ```
290
+ USAGE
291
+ $ learnpack plugins:uninstall PLUGIN...
292
+
293
+ ARGUMENTS
294
+ PLUGIN plugin to uninstall
295
+
296
+ OPTIONS
297
+ -h, --help show CLI help
298
+ -v, --verbose
299
+
300
+ ALIASES
301
+ $ learnpack plugins:unlink
302
+ $ learnpack plugins:remove
303
+ ```
304
+
305
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\uninstall.ts)_
306
+
307
+ ## `learnpack plugins:update`
308
+
309
+ update installed plugins
310
+
311
+ ```
312
+ USAGE
313
+ $ learnpack plugins:update
314
+
315
+ OPTIONS
316
+ -h, --help show CLI help
317
+ -v, --verbose
318
+ ```
319
+
320
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.8.0/src\commands\plugins\update.ts)_
321
+
322
+ ## `learnpack publish`
323
+
324
+ Builds the project by copying necessary files and directories into a zip file
325
+
326
+ ```
327
+ USAGE
328
+ $ learnpack publish
329
+
330
+ OPTIONS
331
+ -h, --help show CLI help
332
+ -s, --strict strict mode
333
+ ```
334
+
335
+ _See code: [src\commands\publish.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\publish.ts)_
336
+
337
+ ## `learnpack serve`
338
+
339
+ Runs a small server to build tutorials
340
+
341
+ ```
342
+ USAGE
343
+ $ learnpack serve
344
+
345
+ OPTIONS
346
+ -d, --debug debugger mode for more verbage
347
+ -h, --host=host server host
348
+ -p, --port=port server port
349
+ -y, --yes Skip all prompts and initialize an empty project
350
+ ```
351
+
352
+ _See code: [src\commands\serve.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\serve.ts)_
353
+
354
+ ## `learnpack start`
355
+
356
+ Runs a small server with all the exercise instructions
357
+
358
+ ```
359
+ USAGE
360
+ $ learnpack start
361
+
362
+ OPTIONS
363
+ -D, --disableGrading disble grading functionality
364
+ -d, --debug debugger mode for more verbage
365
+ -e, --editor=extension|preview [preview, extension]
366
+ -g, --grading=isolated|incremental [isolated, incremental]
367
+ -h, --host=host server host
368
+ -p, --port=port server port
369
+ -v, --version=version E.g: 1.0.1
370
+ -w, --watch Watch for file changes
371
+ -y, --yes Skip all prompts and initialize an empty project
372
+ ```
373
+
374
+ _See code: [src\commands\start.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\start.ts)_
375
+
376
+ ## `learnpack test [EXERCISESLUG]`
377
+
378
+ Test exercises
379
+
380
+ ```
381
+ USAGE
382
+ $ learnpack test [EXERCISESLUG]
383
+
384
+ ARGUMENTS
385
+ EXERCISESLUG The name of the exercise to test
386
+
387
+ OPTIONS
388
+ -y, --yes Skip all prompts and initialize an empty project
389
+ ```
390
+
391
+ _See code: [src\commands\test.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\test.ts)_
392
+
393
+ ## `learnpack translate`
394
+
395
+ List all the lessons, the user is able of select many of them to translate to the given languages
396
+
397
+ ```
398
+ USAGE
399
+ $ learnpack translate
400
+
401
+ OPTIONS
402
+ -y, --yes Skip all prompts and initialize an empty project
403
+ ```
404
+
405
+ _See code: [src\commands\translate.ts](https://github.com/learnpack/learnpack-cli/blob/v5.0.217/src\commands\translate.ts)_
406
+
407
+ <!-- commandsstop -->
408
+
409
+ > > > > > > > 0cb3e56d84c197f9d008836bb573eade212b7e57