summaryrefslogtreecommitdiff
path: root/Documentation/source/reference/commands.rst
blob: 82684006629db82265dece2b87869c1a1b33b5c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
Command Reference
=================

Application
-----------

.. list-table::
   :header-rows: 1
   :widths: 24 52

   * - Command
     - Description
   * - ``pnpm dev``
     - Start the Next.js development server.
   * - ``pnpm build``
     - Build the production application.
   * - ``pnpm start``
     - Start a built production server.
   * - ``pnpm preview``
     - Build and start the production server.

Quality
-------

.. list-table::
   :header-rows: 1
   :widths: 24 52

   * - Command
     - Description
   * - ``pnpm lint``
     - Run project link validation and Biome linting.
   * - ``pnpm check``
     - Run Biome checks.
   * - ``pnpm format``
     - Format files with Biome.
   * - ``pnpm test``
     - Run Vitest once.
   * - ``pnpm test:watch``
     - Run Vitest in watch mode.
   * - ``pnpm test:coverage``
     - Run tests with coverage.

Data and CMS
------------

.. list-table::
   :header-rows: 1
   :widths: 28 48

   * - Command
     - Description
   * - ``pnpm db:generate``
     - Generate Drizzle migration files.
   * - ``pnpm db:migrate``
     - Apply Drizzle migrations.
   * - ``pnpm db:push``
     - Push Drizzle schema changes directly.
   * - ``pnpm db:studio``
     - Open Drizzle Studio.
   * - ``pnpm payload:generate``
     - Generate Payload TypeScript types.
   * - ``pnpm payload:migrate``
     - Run Payload migrations.
   * - ``pnpm payload:migrate:create``
     - Create a Payload migration.

Email
-----

.. list-table::
   :header-rows: 1
   :widths: 24 52

   * - Command
     - Description
   * - ``pnpm email:dev``
     - Start React Email preview server on port 3001.
   * - ``pnpm email:build``
     - Build email templates.
   * - ``pnpm email:export``
     - Export email templates.

Documentation
-------------

.. list-table::
   :header-rows: 1
   :widths: 28 48

   * - Command
     - Description
   * - ``make -C Documentation html``
     - Build Sphinx HTML documentation.
   * - ``make -C Documentation clean``
     - Remove generated Sphinx build output.