You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ This command reports both the version of the CLI and the version of the Adapt fr
39
39
1. To list all the CLI commands with a brief description of each:
40
40
`adapt help`
41
41
42
-
2. To report a brief description of a specific command:
42
+
1. To report a brief description of a specific command:
43
43
`adapt help create`
44
44
45
45
<divfloatalign=right><ahref="#top">Back to Top</a></div>
@@ -60,11 +60,11 @@ This command reports both the version of the CLI and the version of the Adapt fr
60
60
This will create a new directory named "My Course" in your current working directory. It will download the Adapt framework from its master branch, including the default course, into the new directory. Before using the course, run:
61
61
`grunt build`
62
62
63
-
2. To create an Adapt course from a specific branch:
63
+
1. To create an Adapt course from a specific branch:
64
64
`adapt create course "My Course" develop`
65
65
This is the same as example 1 except that the framework will be downloaded from its develop branch, not from the default master branch.
66
66
67
-
3. To create an empty component:
67
+
1. To create an empty component:
68
68
`adapt create component "test-component"`
69
69
This command is useful for developing new components. It will create a new directory named "test-component" in the current working directory. It will populate the directory with files required for an Adapt component and insert "test-component" into the code where required.
70
70
<divfloatalign=right><ahref="#top">Back to Top</a></div>
@@ -82,7 +82,7 @@ The **search** command searches within [Adapt Plugin Browser](https://www.adaptl
82
82
1. To view the name and repository of all plug-ins registered with the Adapt Plugin Browser:
83
83
`adapt search`
84
84
85
-
2. To locate the repository of a known plug-in that is registered:
85
+
1. To locate the repository of a known plug-in that is registered:
86
86
`adapt search adapt-contrib-pageLevelProgress` OR
87
87
`adapt search contrib-pageLevelProgress` OR
88
88
`adapt search pageLevel`
@@ -102,32 +102,32 @@ The **search** command searches within [Adapt Plugin Browser](https://www.adaptl
102
102
`adapt install`
103
103
This command must be run in the root directory of an Adapt framework installation.
104
104
105
-
2. To report the plug-ins that will be installed if `adapt install` is run:
105
+
1. To report the plug-ins that will be installed if `adapt install` is run:
106
106
`adapt install --dry-run`
107
107
This command must be run in the root directory of an Adapt framework installation.
108
108
109
-
3. To install versions of all plug-ins listed in *adapt.json* that are compatible with the installed framework version. This overrides any incompatible settings provided on the command line or in *adapt.json*.
109
+
1. To install versions of all plug-ins listed in *adapt.json* that are compatible with the installed framework version. This overrides any incompatible settings provided on the command line or in *adapt.json*.
110
110
`adapt install --compatible`
111
111
This command must be run in the root directory of an Adapt framework installation.
112
112
113
-
4. To install a plug-in that has been registered with the [Adapt Plug-in Browser](https://www.adaptlearning.org/index.php/plugin-browser/) registry:
113
+
1. To install a plug-in that has been registered with the [Adapt Plug-in Browser](https://www.adaptlearning.org/index.php/plugin-browser/) registry:
114
114
`adapt install adapt-contrib-pageLevelProgress` OR
115
115
`adapt install contrib-pageLevelProgress`
116
116
117
-
5. To install a specific version of a registered plug-in:
117
+
1. To install a specific version of a registered plug-in:
118
118
`adapt install adapt-contrib-pageLevelProgress#1.1.0` OR
119
119
`adapt install adapt-contrib-pageLevelProgress@1.1.0` OR
120
120
`adapt install contrib-pageLevelProgress#1.1.0` OR
121
121
`adapt install contrib-pageLevelProgress@1.1.0`
122
122
123
-
6. To use the CLI to install a plug-in that is not registered with [Adapt Plug-in Browser](https://www.adaptlearning.org/index.php/plugin-browser/) registry:
123
+
1. To use the CLI to install a plug-in that is not registered with [Adapt Plug-in Browser](https://www.adaptlearning.org/index.php/plugin-browser/) registry:
124
124
1. Copy the uncompressed folder to the proper location for the type of plug-in. Components: *src/components*. Extensions: *src/extensions*. Menu: *src/menu*. Theme: *src/theme*. Note: The Adapt framework allows only one theme. Uninstall the current before replacing it with an alternative. More than one menu is allowed.
125
-
2. Open *adapt.json* in an editor and add the full name of the new component to the list.
126
-
3. Run the following command from the course root:
125
+
1. Open *adapt.json* in an editor and add the full name of the new component to the list.
126
+
1. Run the following command from the course root:
127
127
`adapt install`
128
128
After installation, most CLI commands will operate on the plug-in with the exception of `adapt update`. Plug-ins must be registered with the [Adapt Plugin Browser](https://www.adaptlearning.org/index.php/plugin-browser/) for `adapt update` to succeed.
129
129
130
-
7. To update all registered plug-ins to their most recent public release:
130
+
1. To update all registered plug-ins to their most recent public release:
131
131
`adapt update`
132
132
Since no plug-in name is specified in this command, all plug-ins listed in *adapt.json* are reinstalled. Whether the plug-in is updated will be determined by the compatible framework versions specified in *adapt.json*. If it includes a plug-in that is not registered, it will not be updated.
133
133
**Note to developers:** The CLI determines newest version by comparing release tags in the GitHub repo. Be sure to use a tag when you release a new version.
@@ -168,10 +168,10 @@ Because the plug-in registry is not referenced during the uninstall process, thi
168
168
1. To clone as git repositories the Adapt framework and all the plug-ins listed in *adapt.json* of the current directory:
169
169
`adapt devinstall`
170
170
171
-
2. To clone a specific plug-in listed in the *adapt.json*:
171
+
1. To clone a specific plug-in listed in the *adapt.json*:
172
172
`adapt devinstall adapt-contrib-matching`
173
173
174
-
3. To clone a specific version of a plug-in listed in the *adapt.json*:
174
+
1. To clone a specific version of a plug-in listed in the *adapt.json*:
175
175
`adapt devinstall adapt-contrib-matching#v2.2.0`
176
176
<divfloatalign=right><ahref="#top">Back to Top</a></div>
177
177
@@ -193,11 +193,11 @@ Note: The `--check` option may be used to report on a specific plug-in or on a c
193
193
`adapt update adapt-contrib-matching --check`
194
194
`adapt update extensions --check`
195
195
196
-
2. To update a registered plug-in:
196
+
1. To update a registered plug-in:
197
197
`adapt update adapt-contrib-pageLevelProgress` OR
198
198
`adapt update contrib-pageLevelProgress`
199
199
200
-
3. To update a specific version of a registered plug-in:
200
+
1. To update a specific version of a registered plug-in:
201
201
`adapt update adapt-contrib-pageLevelProgress#1.1.0` OR
202
202
`adapt update adapt-contrib-pageLevelProgress@1.1.0` OR
203
203
`adapt update contrib-pageLevelProgress#1.1.0` OR
@@ -244,7 +244,7 @@ Please note that you must authenticate with GitHub to use **unregister**. You mu
244
244
1. To unregister a plug-in while in the root directory of the plug-in:
245
245
`adapt unregister`
246
246
247
-
2. To unregister a plug-in by name:
247
+
1. To unregister a plug-in by name:
248
248
`adapt unregister adapt-myMistake`
249
249
<divfloatalign=right><ahref="#top">Back to Top</a></div>
0 commit comments