diff --git a/docs/cli.md b/docs/cli.md index 968fc221..1aae594d 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -1,6 +1,7 @@ --- id: cli title: Command-Line Interface (CLI) +description: Install Unibeautify's command-line interface (CLI) to format code for many languages --- Install [Unibeautify's CLI](https://github.com/Unibeautify/unibeautify-cli): @@ -12,13 +13,13 @@ npm install --save-dev unibeautify-cli npm install --global unibeautify-cli ``` -And then install your beautifiers along with any [`peerDependencies`](https://docs.npmjs.com/files/package.json#peerdependencies). +And then install your beautifiers along with any prerequisites and [`peerDependencies`](https://docs.npmjs.com/files/package.json#peerdependencies). ```bash # Locally npm install --save-dev beautifier-CHANGEME # Or globally -npm install --global beautifier-CHANGE +npm install --global beautifier-CHANGEME ``` For example, locally installing [`beautifier-prettier`](https://yarnpkg.com/en/package/@unibeautify/beautifier-prettier): @@ -33,4 +34,110 @@ And [`prettier`](https://yarnpkg.com/en/package/prettier) is a peer dependency: npm install --save-dev prettier --exact ``` -See [`unibeautify-cli` repository](https://github.com/Unibeautify/unibeautify-cli) for more information. [Click here for a list of published beautifiers.](https://yarnpkg.com/en/packages?q=beautifier-&p=1&keywords%5B0%5D=unibeautify) +See [`unibeautify-cli` repository](https://github.com/Unibeautify/unibeautify-cli) for more information. [Click here for a list of published beautifiers.](https://classic.yarnpkg.com/en/packages?q=beautifier-&p=1&keywords%5B0%5D=unibeautify) + +