@mintlify/cli 3.0.13 → 3.0.15
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.
- package/CONTRIBUTING.md +8 -4
- package/package.json +2 -2
package/CONTRIBUTING.md
CHANGED
|
@@ -1,12 +1,16 @@
|
|
|
1
1
|
# Running CLI Locally
|
|
2
2
|
|
|
3
|
-
Note
|
|
3
|
+
Note: contributing requires `yarn` and it's recommended you install it as a global installation. If you don't have yarn installed already run `npm install -g yarn` in your terminal.
|
|
4
4
|
|
|
5
|
-
Run `yarn` or `yarn install` to install dependencies. Then, run `npm link` once to link to your local version of the CLI in the npm global namespace (`npm list -g`).
|
|
5
|
+
Run `yarn` or `yarn install` to install dependencies. Then, run `npm link` once to link to your local version of the CLI in the npm global namespace (`npm list -g`). Make sure you are working in `packages/mintlify-cli` and not its alias package, `packages/mintlify`.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
If you already have a non-local version of the CLI, you will need to uninstall it (`npm uninstall -g mintlify`) or force overwrite the executable file. Otherwise, you will get an `EEXIST` error on the mintlify binary. You can overwrite the file using the `--force` flag (`npm link --force`), but always double check the file(s) you are overwriting.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Make sure to build the CLI using `yarn build` or `yarn watch` to see your local changes reflected. Tip: keep `yarn watch` running in a separate terminal for changes to be quickly and continuously reflected while developing.
|
|
10
|
+
|
|
11
|
+
To uninstall locally, run `npm uninstall -g @mintlify/cli`.
|
|
12
|
+
|
|
13
|
+
If you wish to continue using the production version of the CLI, you will need to reinstall it (`npm install -g mintlify`). If you do not uninstall `@mintlify/cli`, then you will need to force overwrite the executable file (`npm install -g mintlify --force`) for the same reasons as mentioned above. As a best practice, we recommend always uninstalling `@mintlify/cli` first.
|
|
10
14
|
|
|
11
15
|
## Updating Version of Mint Client
|
|
12
16
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mintlify/cli",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.15",
|
|
4
4
|
"description": "The Mintlify CLI",
|
|
5
5
|
"engines": {
|
|
6
6
|
"node": ">=18.0.0"
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
48
|
"@apidevtools/swagger-parser": "^10.1.0",
|
|
49
|
-
"@mintlify/previewing": "^3.1.
|
|
49
|
+
"@mintlify/previewing": "^3.1.7",
|
|
50
50
|
"@mintlify/validation": "^0.1.12",
|
|
51
51
|
"@octokit/rest": "^19.0.5",
|
|
52
52
|
"axios": "^1.2.2",
|