1  ---
 2  title: NPM Scripts
 3  order: 3
 4  ---
 5  
 6  # Npm Scripts
 7  
 8  > $ npm run %SCRIPT_NAME%
 9  
10  ## General
11  
12  | Script Name | Description |
13  | --- | --- |
14  | `dev` | Start Electron as a development environment |
15  | `dev:debug` | Start Electron as a development environment (with vite debug) |
16  | `dev:debug:force` | Start Electron as a development environment (with vite debug + clean vite cache) |
17  | `build:pre` | Commands commonly run at build time. This script does not need to be run separately. |
18  | `build` | Build the package for the current operating system. |
19  | `build:all` | Build a specified package for the entire operating system (Requires cross-platform build configuration) |
20  | `build:dir` | `electron-builder` directory build |
21  | `build:mac` | Build preconfigured packages for macOS |
22  | `build:linux` | Build preconfigured packages for Linux |
23  | `build:win` | Build preconfigured packages for Windows |
24  | `lint` | ESLint code inspection. It does not modify the code. |
25  | `lint:fix` | ESLint code inspection. Use auto-fix to fix your code. |
26  | `format` | Prettier code inspection. It does not modify the code. |
27  | `format:fix` | Prettier code inspection. Use auto-fix to fix your code. |
28  | `test` | Build a package for testing and run tests against the test specification file. |
29  | `test:linux` | Build a package for testing and run tests against the test specification file. (for linux ci only) |
30  
31  ## For Documentation
32  
33  Used only for contributing to project documentation. Must be run from the `docs` directory location.
34  
35  | Script Name | Description                                                        |
36  | ----------- | ------------------------------------------------------------------ |
37  | `dev`       | Start the local document server. (For development)                 |
38  | `build`     | Build a local document server. Used only for GitHub page builders. |
39  | `serve`     | Start the local document server.                                   |