|
| 1 | +--- |
| 2 | +id: version-1.5.1-commands |
| 3 | +title: CLI Commands |
| 4 | +original_id: commands |
| 5 | +--- |
| 6 | + |
| 7 | +Docusaurus provides a set of scripts to help you generate, serve, and deploy your website. These scripts can be invoked with the `run` command when using Yarn or npm. Some common commands are: |
| 8 | + |
| 9 | +* [`yarn run start`](api-commands.md#docusaurus-start-port-number): build and serve the website from a local server |
| 10 | +* [`yarn run examples`](api-commands.md#docusaurus-examples): create example configuration files |
| 11 | + |
| 12 | +## Running from the command line |
| 13 | + |
| 14 | +The scripts can be run using either Yarn or npm. If you've already gone through our Getting Started guide, you may already be familiar with the `start` command. It's the command that tells Docusaurus to run the `docusaurus-start` script which generates the site and starts up a server, and it's usually invoked like so: |
| 15 | + |
| 16 | +```bash |
| 17 | +yarn run start |
| 18 | +``` |
| 19 | + |
| 20 | +The same script can be invoked using npm: |
| 21 | + |
| 22 | +```bash |
| 23 | +npm run start |
| 24 | +``` |
| 25 | + |
| 26 | +To run a particular script, just replace the `start` command in the examples above with the command associated with your script. |
| 27 | + |
| 28 | +## Using arguments |
| 29 | + |
| 30 | +Some commands support optional arguments. For example, to start a server on port 8080, you can specify the `--port` argument when running `start`: |
| 31 | + |
| 32 | +```bash |
| 33 | +yarn run start --port 8080 |
| 34 | +``` |
| 35 | + |
| 36 | +If you run Docusaurus using npm, you can still use the command line arguments by inserting a `--` between `npm run <command>` and the command arguments: |
| 37 | + |
| 38 | +```bash |
| 39 | +npm run start -- --port 8080 |
| 40 | +``` |
| 41 | + |
| 42 | +## Configuration |
| 43 | + |
| 44 | +These scripts are set up under the `"scripts"` key in your `website/package.json` file as part of the installation process. If you need help setting them up again, please refer to the [Installation guide](getting-started-installation.md). |
| 45 | + |
| 46 | +Docusaurus provides some default mappings to allow you to run commands following Node conventions. Instead of typing `docusaurus-start` every time, you can type `yarn run start` or `npm start` to achieve the same. |
| 47 | + |
| 48 | +## Commands |
| 49 | + |
| 50 | +<AUTOGENERATED_TABLE_OF_CONTENTS> |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +## Reference |
| 55 | + |
| 56 | +### `docusaurus-build` |
| 57 | + |
| 58 | +Alias: `build`. |
| 59 | + |
| 60 | +| Options | Default | Description | |
| 61 | +| -------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------- | |
| 62 | +| `--skip-image-compression` | `false` | Skip compression of image assets. You usually won't want to skip this unless your images have already been optimized. | |
| 63 | + |
| 64 | +Generates the static website, applying translations if necessary. Useful for building the website prior to deployment. |
| 65 | + |
| 66 | +See also [`docusaurus-start`](api-commands.md#docusaurus-start). |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +### `docusaurus-examples` |
| 71 | + |
| 72 | +Alias: `examples` |
| 73 | + |
| 74 | +| Arguments | Default | Description | |
| 75 | +| ----------- | ------- | ---------------------------------------------------------------------------------------------------- | |
| 76 | +| `<feature>` | - | Specify a feature `translations` or `versions` to generate the extra example files for that feature. | |
| 77 | + |
| 78 | +**Example** |
| 79 | + |
| 80 | +```bash |
| 81 | +docusaurus-examples <feature> |
| 82 | +``` |
| 83 | + |
| 84 | +When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the [Site Preparation guide](getting-started-preparation.md). |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +### `docusaurus-publish` |
| 89 | + |
| 90 | +Alias: `publish-gh-pages` |
| 91 | + |
| 92 | +[Builds](api-commands.md#docusaurus-build), then deploys the static website to GitHub Pages. This command is meant to be run during the deployment step in Circle CI, and therefore expects a few environment variables to be defined: |
| 93 | + |
| 94 | +The following environment variables are generally set manually by the user in the CircleCI `config.yml` file. |
| 95 | + |
| 96 | +* `GIT_USER`: The git user to be associated with the deploy commit. |
| 97 | +* `USE_SSH`: Whether to use SSH instead of HTTPS for your connection to the GitHub repo. |
| 98 | + |
| 99 | +**Example** |
| 100 | + |
| 101 | +```bash |
| 102 | +GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages |
| 103 | +``` |
| 104 | + |
| 105 | +The following environment variables are [set by CircleCI](https://circleci.com/docs/1.0/environment-variables/) during the build process. |
| 106 | + |
| 107 | +* `CIRCLE_BRANCH`: The git branch associated with the commit that triggered the CI run. |
| 108 | +* `CI_PULL_REQUEST`: Expected to be truthy if the current CI run was triggered by a commit in a pull request. |
| 109 | + |
| 110 | +The following should be set by you in `siteConfig.js` as `organizationName` and `projectName`, respectively. If they are not set in your site configuration, they fall back to the [CircleCI environment](https://circleci.com/docs/1.0/environment-variables/). |
| 111 | + |
| 112 | +* `CIRCLE_PROJECT_USERNAME`: The GitHub username or organization name that hosts the Git repo, e.g. "facebook". |
| 113 | +* `CIRCLE_PROJECT_REPONAME`: The name of the Git repo, e.g. "Docusaurus". |
| 114 | + |
| 115 | +You can learn more about configuring automatic deployments with CircleCI in the [Publishing guide](getting-started-publishing.md). |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +### `docusaurus-rename-version` |
| 120 | + |
| 121 | +Alias: `rename-version` |
| 122 | + |
| 123 | +Renames an existing version of the docs to a new version name. |
| 124 | + |
| 125 | +| Arguments | Default | Description | |
| 126 | +| ------------------ | ------- | ------------------------- | |
| 127 | +| `<currentVersion>` | - | Version to be renamed. | |
| 128 | +| `<newVersion>` | - | Version to be renamed to. | |
| 129 | + |
| 130 | +**Example** |
| 131 | + |
| 132 | +```bash |
| 133 | +docusaurus-rename-version <currentVersion> <newVersion> |
| 134 | +``` |
| 135 | + |
| 136 | +See the [Versioning guide](guides-versioning.md#renaming-existing-versions) to learn more. |
| 137 | + |
| 138 | +--- |
| 139 | + |
| 140 | +### `docusaurus-start` |
| 141 | + |
| 142 | +Alias: `start`. |
| 143 | + |
| 144 | +This command will build the static website, apply translations if necessary, and then start a local server. |
| 145 | + |
| 146 | +| Options | Default | Description | |
| 147 | +| ----------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ | |
| 148 | +| `--port <number>` | `3000` | The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one. | |
| 149 | +| `--watch` | - | Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using `--no-watch`. | |
| 150 | + |
| 151 | +You can specify the browser application to be opened by setting the `BROWSER` environment variable before the command, e.g.: |
| 152 | + |
| 153 | +``` |
| 154 | +$ BROWSER=firefox yarn start |
| 155 | +``` |
| 156 | + |
| 157 | +--- |
| 158 | + |
| 159 | +### `docusaurus-version <version>` |
| 160 | + |
| 161 | +Alias: `version` |
| 162 | + |
| 163 | +Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number. |
| 164 | + |
| 165 | +See the [Versioning guide](guides-versioning.md) to learn more. |
| 166 | + |
| 167 | +--- |
| 168 | + |
| 169 | +### `docusaurus-write-translations` |
| 170 | + |
| 171 | +Alias: `write-translations` |
| 172 | + |
| 173 | +Writes the English for any strings that need to be translated into an `website/i18n/en.json` file. The script will go through every file in `website/pages/en` and through the `siteConfig.js` file and other config files to fetch English strings that will then be translated on Crowdin. See the [Translation guide](guides-translation.md) to learn more. |
0 commit comments