Strapi

https://github.com/strapi/documentation
Admin
Strapi is a free and open-source headless CMS that delivers your content anywhere you need, offering...
Tokens:1,753,541
Snippets:12,893
Trust Score:9.9
License:MIT
Update:2 days ago
Show doc for...
Tokens:
Raw
### Enterprise install examples with npm

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/cli.md

Shows npm commands to choose plugins from a list, install by name, and install a specific version.

```bash
# Choose plugins from a list
npm run strapi enterprise install

# Install a plugin by name
npm run strapi enterprise install plugin-byok

# Install a specific version
npm run strapi enterprise install plugin-byok@1.0.0
```

--------------------------------

### Enterprise install examples with pnpm

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/cli.md

Shows pnpm commands to choose plugins from a list, install by name, and install a specific version.

```bash
# Choose plugins from a list
pnpm strapi enterprise install

# Install a plugin by name
pnpm strapi enterprise install plugin-byok

# Install a specific version
pnpm strapi enterprise install plugin-byok@1.0.0
```

--------------------------------

### Start server on Windows

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Setup and start commands for Windows environments using cross-env.

```bash
npm install --save-dev cross-env
```

```json
"start:win": "cross-env NODE_ENV=production npm run start",
```

```bash
npm run start:win
```

--------------------------------

### Enterprise install examples with Yarn

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/cli.md

Shows Yarn commands to choose plugins from a list, install by name, and install a specific version.

```bash
# Choose plugins from a list
yarn strapi enterprise install

# Install a plugin by name
yarn strapi enterprise install plugin-byok

# Install a specific version
yarn strapi enterprise install plugin-byok@1.0.0
```

--------------------------------

### Install cross-env for Windows start

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Install cross-env as a dev dependency to set NODE_ENV on Windows. Then add a start:win script to package.json and run it.

```Bash
npm install --save-dev cross-env
```

```JSON
"start:win": "cross-env NODE_ENV=production npm run start",
```

```Bash
npm run start:win
```

--------------------------------

### Install dependencies and start the server

Source: https://github.com/strapi/documentation/blob/main/CONTRIBUTING.md

Installs dependencies with yarn and starts the Docusaurus development server. Requires node 16.14+.

```bash
yarn && yarn dev
```

--------------------------------

### Create a plugin with @strapi/sdk-plugin init (NPM)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/plugins-development/create-a-plugin.md

Run this command in the parent directory where you want the plugin created. Replace `my-strapi-plugin` with your desired plugin name or path. You will be guided through setup prompts.

```bash
npx @strapi/sdk-plugin init my-strapi-plugin
```

--------------------------------

### Start Strapi development server with npm run develop

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/quick-start.md

After installation, run this command to start the Strapi server. Your browser automatically opens a new tab. As long as you stay in the my-strapi-project folder, you can use npm run develop to start the server again.

```sh
cd my-strapi-project && npm run develop

```

--------------------------------

### Basic plugin configuration in JavaScript (./config/plugins.js)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/plugins.md

JavaScript example showing how to enable a plugin without configuration, enable a custom local plugin with resolve and config, and disable an installed plugin. Use this in /config/plugins.js.

```javascript
module.exports = ({ env }) => ({
  // enable a plugin that doesn't require any configuration
  i18n: true,

  // enable a custom plugin
  myplugin: {
    // my-plugin is going to be the internal name used for this plugin
    enabled: true,
    resolve: './src/plugins/my-local-plugin',
    config: {
      // user plugin config goes here
    },
  },

  // disable a plugin
  'my-other-plugin': {
    enabled: false, // plugin installed but disabled
  },
});
```

--------------------------------

### Install dependencies in cloned project (npm)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/features/data-management/transfer-locally.md

Moves into the cloned project and installs dependencies using npm. Without this step, the next build and start commands fail because strapi is not yet on the project's local executable path.

```bash
cd <new-instance-name>
npm install
```

--------------------------------

### Create a plugin with @strapi/sdk-plugin init (Yarn)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/plugins-development/create-a-plugin.md

Run this command in the parent directory where you want the plugin created. Replace `my-strapi-plugin` with your desired plugin name or path. You will be guided through setup prompts.

```bash
yarn dlx @strapi/sdk-plugin init my-strapi-plugin
```

--------------------------------

### Install dependencies in cloned project (yarn)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/features/data-management/transfer-locally.md

Moves into the cloned project and installs dependencies using yarn. Without this step, the next build and start commands fail because strapi is not yet on the project's local executable path.

```bash
cd <new-instance-name>
yarn install
```

--------------------------------

### Create a new Strapi project with TypeScript using Yarn

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/typescript.md

Use this command in a terminal to create a new Strapi project with TypeScript support. This is one of two ways to get started; additional installation details are in the CLI installation guide.

```bash
yarn create strapi-app my-project --typescript
```

--------------------------------

### Basic plugin configuration in TypeScript (./config/plugins.ts)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/plugins.md

TypeScript example showing how to enable a plugin without configuration, enable a custom local plugin with resolve and config, and disable an installed plugin. Use this in /config/plugins.ts.

```typescript
import type { Core } from '@strapi/strapi';

export default ({ env }: Core.Config.Shared.ConfigParams): Core.Config.Plugin => ({
  // enable a plugin that doesn't require any configuration
  i18n: true,

  // enable a custom plugin
  myplugin: {
    // my-plugin is going to be the internal name used for this plugin
    enabled: true,
    resolve: './src/plugins/my-local-plugin',
    config: {
      // user plugin config goes here
    },
  },

  // disable a plugin
  'my-other-plugin': {
    enabled: false, // plugin installed but disabled
  },
});
```

--------------------------------

### GET /api/upload/files/page - Example request and response (offset-based)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/rest/upload.md

Example request using pagination[start], pagination[limit], and pagination[withCount]=false with a filter. The response's meta.pagination returns start and limit instead of page and pageSize, and omits total and pageCount when withCount is false.

```http
GET /api/upload/files/page?pagination[start]=20&pagination[limit]=5&pagination[withCount]=false&filters[mime][$startsWith]=image/
```

```json
{
  "data": [
    // ...
  ],
  "meta": {
    "pagination": {
      "start": 20,
      "limit": 5
    }
  }
}
```

--------------------------------

### useFetchClient get usage example

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example of using the get method from useFetchClient to fetch data.

```tsx
const { get } = useFetchClient();

const { data } = await get(requestURL);
```

--------------------------------

### $startsWith operator example

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/entity-service/filter.md

Attribute starts with input value. The example filters articles where the title starts with 'ABCD'.

```javascript
const entries = await strapi.entityService.findMany('api::article.article', {
  filters: {
    title: {
      $startsWith: 'ABCD',
    },
  },
});
```

--------------------------------

### Create a new Strapi project with quickstart

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/features/data-management/transfer-locally.md

Initializes a new Strapi project using the quickstart option. Do not add any data to the project at this step.

```bash
npx create-strapi-app@latest <project-name> --quickstart
```

--------------------------------

### strapi configuration:dump examples

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/cli.md

Equivalent examples for dumping configuration to a file or stdout.

```bash
strapi configuration:dump -f dump.json
```

```bash
strapi config:dump --file dump.json
```

```bash
strapi config:dump > dump.json
```

--------------------------------

### strapi configuration:restore examples

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/cli.md

Equivalent examples for restoring configuration from a file or stdin.

```bash
strapi configuration:restore -f dump.json
```

```bash
strapi config:restore --file dump.json -s replace
```

```bash
cat dump.json | strapi config:restore
```

```bash
strapi config:restore < dump.json
```

--------------------------------

### Example .env file

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Sample content for a .env file to override default host and port settings.

```text
HOST=10.0.0.1
PORT=1338
```

--------------------------------

### Full server configuration (JavaScript)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/server.md

Full configuration example for `./config/server.js` in JavaScript. Includes optional keys for socket, URL, proxy, cron, transfer, logger, and OpenAPI. Not all keys are required.

```JavaScript
module.exports = ({ env }) => ({
  host: env('HOST', '0.0.0.0'),
  port: env.int('PORT', 1337),
  app: {
    keys: env.array('APP_KEYS'),
  },
  socket: '/tmp/nginx.socket', // only use if absolutely required
  url: env('PUBLIC_URL', 'https://api.example.com'),
  proxy: {
    koa: env.bool('IS_PROXIED', true),
    ipHeader: env('PROXY_IP_HEADER', 'X-Forwarded-For'),
    maxIpsCount: env.int('MAX_IPS_COUNT', 1),
  },
  cron: {
    enabled: env.bool('CRON_ENABLED', false),
  },
  transfer: {
    remote: {
      enabled: false,
    },
  },
  logger: {
    updates: {
      enabled: false,
    },
    startup: {
      enabled: false,
    },
  },
  // highlight-start
  openapi: {
    'content-api': {
      access: 'public',
    },
  },
  // highlight-end
});
```

--------------------------------

### Example server configuration (JS)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Example configuration file for the server, exporting an object with a host property.

```javascript
  module.exports = {
    host: '0.0.0.0',
  };
  
```

--------------------------------

### GET /api/:pluralApiId/:documentId - cURL and JavaScript examples

Source: https://github.com/strapi/documentation/blob/main/claude-plugins/inki/references/templates/components/endpoint.md

Example requests for the GET endpoint. The cURL command and JavaScript fetch call both target the same URL and require an Authorization header with a bearer token.

```bash
curl 'http://localhost:1337/api/restaurants/znrlzntu9ei5onjvwfaalu2v' \
  -H 'Authorization: Bearer <token>'
```

```javascript
const response = await fetch(
  'http://localhost:1337/api/restaurants/znrlzntu9ei5onjvwfaalu2v',
  {
    headers: {
      Authorization: 'Bearer <token>',
    },
  }
);
const data = await response.json();
```

--------------------------------

### Start server with npm

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Command to start the production server using npm.

```bash
NODE_ENV=production npm run start
```

--------------------------------

### Bootstrap lifecycle function: seed default category (JavaScript)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Use the bootstrap function to run code after Strapi setup but before the server starts. This example checks if a category with slug 'general' exists and creates it if not, logging an info message. It demonstrates access to the strapi object and documents API.

```javascript
module.exports = {
  async bootstrap({ strapi }) {
    const categories = await strapi
      .documents('api::category.category')
      .findMany({ filters: { slug: 'general' }, pageSize: 1 });

    if (categories.length === 0) {
      await strapi.documents('api::category.category').create({
        data: { name: 'General', slug: 'general' },
      });
      strapi.log.info('Created default category');
    }
  },
};
```

--------------------------------

### Create Strapi app with SQLite quickstart (npm)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/database.md

Use this command to create a new Strapi project with SQLite as the default database. It will create a new project and launch it in the browser.

```bash
npx create-strapi-app@latest my-project --quickstart
```

--------------------------------

### findMany() - Get the published version

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Retrieves multiple documents with the specified status. The example shows how to get all published restaurant documents.

```APIDOC
## findMany()

### Description
Retrieves multiple documents with the specified status. The example shows how to get all published restaurant documents.

### Method
findMany

### Endpoint
strapi.documents("api::restaurant.restaurant").findMany()

### Parameters
- **status** (string) - Optional - The status of the documents to retrieve. Use 'published' to get published versions.

### Request Example
```js
const documents = await strapi.documents("api::restaurant.restaurant").findMany({
  status: 'published'
});
```

### Response Example
```json
[
  {
    documentId: "a1b2c3d4e5f6g7h8i9j0klm",
    name: "Biscotte Restaurant",
    publishedAt: "2024-03-14T15:40:45.330Z",
    locale: "en", // default locale
    // …
  }
  // …
]
```
```

--------------------------------

### Build and start second instance (npm)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/features/data-management/transfer-locally.md

Builds and starts the second Strapi instance using npm. Run in the root directory of the second instance.

```bash
npm run build && npm run start
```

--------------------------------

### Pagination with limit and start using strapi.documents().findMany()

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/document-service/sort-pagination.md

Paginate results using the limit and start parameters. The example sets limit to 10 and start to 0 to fetch the first 10 results.

```JavaScript
const documents = await strapi.documents("api::article.article").findMany({
  limit: 10,
  start: 0,
});
```

```JSON
[
  {
    "documentId": "cjld2cjxh0000qzrmn831i7rn",
    "title": "Test Article",
    "slug": "test-article",
    "body": "Test 1"
  },
  {
    "documentId": "cjld2cjxh0001qzrm5q1j5q7m",
    "title": "Test Article 2",
    "slug": "test-article-2",
    "body": "Test 2"
  }
]
```

--------------------------------

### findOne() - Get the published version

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Retrieves a single document by its documentId with the specified status. The example shows how to get the published version of a restaurant document.

```APIDOC
## findOne()

### Description
Retrieves a single document by its documentId with the specified status. The example shows how to get the published version of a restaurant document.

### Method
findOne

### Endpoint
strapi.documents('api::restaurant.restaurant').findOne()

### Parameters
- **documentId** (string) - Required - The document identifier.
- **status** (string) - Optional - The status of the document to retrieve. Use 'published' to get the published version.

### Request Example
```js
await strapi.documents('api::restaurant.restaurant').findOne({
  documentId: 'a1b2c3d4e5f6g7h8i9j0klm',
  status: 'published'
});
```

### Response Example
```json
{
  documentId: "a1b2c3d4e5f6g7h8i9j0klm",
  name: "Biscotte Restaurant",
  publishedAt: "2024-03-14T15:40:45.330Z",
  locale: "en", // default locale
  // …
}
```
```

--------------------------------

### Minimal configuration example in ./config/<area>.js

Source: https://github.com/strapi/documentation/blob/main/claude-plugins/inki/references/templates/feature-template.md

Shows a minimal JavaScript configuration file for the feature. Replace optionName and value with actual configuration options.

```JavaScript
// Minimal configuration illustrating the feature
module.exports = {
  optionName: 'value',
};
```

--------------------------------

### Basic route definition for GET /hello

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Defines a route that maps GET /hello to the 'api::hello.hello.index' handler. This is part of a basic hello world example.

```javascript
  routes: [
    {
      method: 'GET',
      path: '/hello',
      handler: 'api::hello.hello.index',
    }
  ]
}
```

--------------------------------

### Get all documents - JSON response

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example JSON response for a successful GET request to /api/restaurants. Shows the data array with document fields and pagination meta.

```JSON
{
  "data": [
    {
      "id": 2,
      "documentId": "hgv1vny5cebq2l3czil1rpb3",
      "Name": "BMK Paris Bamako",
      "Description": null,
      "createdAt": "2024-03-06T13:42:05.098Z",
      "updatedAt": "2024-03-06T13:42:05.098Z",
      "publishedAt": "2024-03-06T13:42:05.103Z",
      "locale": "en"
    },
    {
      "id": 4,
      "documentId": "znrlzntu9ei5onjvwfaalu2v",
      "Name": "Biscotte Restaurant",
      "createdAt": "2024-03-06T13:43:30.172Z",
      "updatedAt": "2024-03-06T13:43:30.172Z",
      "publishedAt": "2024-03-06T13:43:30.175Z",
      "locale": "en"
    }
  ],
  "meta": {
    "pagination": { "page": 1, "pageSize": 25, "pageCount": 1, "total": 2 }
  }
}
```

--------------------------------

### Response for GET /api/articles without populate (JSON)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example JSON response returned by the GET /api/articles request without populate. Shows the default attributes (id, documentId, title, slug, createdAt, updatedAt, publishedAt, locale, ckeditor_content) and pagination meta. The ckeditor_content field is truncated in the example.

```json
{
  "data": [
    {
      "id": 1,
      "documentId": "t3q2i3v1z2j7o8p6d0o4xxg",
      "title": "Here's why you have to try basque cuisine, according to a basque chef",
      "slug": "here-s-why-you-have-to-try-basque-cuisine-according-to-a-basque-chef",
      "createdAt": "2021-11-09T13:33:19.948Z",
      "updatedAt": "2023-06-02T10:57:19.584Z",
      "publishedAt": "2022-09-22T09:30:00.208Z",
      "locale": "en",
      "ckeditor_content": "// truncated content"
    },
    {
      "id": 2,
      "documentId": "k2r5l0i9g3u2j3b4p7f0sed",
      "title": "What are chinese hamburgers and why aren't you eating them?",
      "slug": "what-are-chinese-hamburgers-and-why-aren-t-you-eating-them",
      "createdAt": "2021-11-11T13:33:19.948Z",
      "updatedAt": "2023-06-01T14:32:50.984Z",
      "publishedAt": "2022-09-22T12:36:48.312Z",
      "locale": "en",
      "ckeditor_content": "// truncated content"
    },
    {
      "id": 3,
      "documentId": "k6m6l9q0n6v9z2m3i0z5jah",
      "title": "7 Places worth visiting for the food alone",
      "slug": "7-places-worth-visiting-for-the-food-alone",
      "createdAt": "2021-11-12T13:33:19.948Z",
      "updatedAt": "2023-06-02T11:30:00.075Z",
      "publishedAt": "2023-06-02T11:30:00.075Z",
      "locale": "en",
      "ckeditor_content": "// truncated content"
    },
    {
      "id": 4,
      "documentId": "d5m4b6z6g5d9e3v1k9n5gbn",
      "title": "If you don't finish your plate in these countries, you might offend someone",
      "slug": "if-you-don-t-finish-your-plate-in-these-countries-you-might-offend-someone",
      "createdAt": "2021-11-15T13:33:19.948Z",
      "updatedAt": "2023-06-02T10:59:35.148Z",
      "publishedAt": "2022-09-22T12:35:53.899Z",
      "locale": "en",
      "ckeditor_content": "// truncated content"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}
```

--------------------------------

### Create Strapi app with SQLite quickstart (yarn)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/database.md

Use this command to create a new Strapi project with SQLite as the default database. It will create a new project and launch it in the browser.

```bash
yarn create strapi-app my-project --quickstart
```

--------------------------------

### $startsWith filter example

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Filters articles where the title starts with the string 'ABCD'.

```JavaScript
const entries = await strapi.entityService.findMany('api::article.article', {
  filters: {
    title: {
      $startsWith: 'ABCD',
    },
  },
});
```

--------------------------------

### Setup Strapi instance and register hello route

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Creates and loads a Strapi instance, registering a /api/hello test route if not already done.

```javascript
async function setupStrapi() {
  if (!instance) {
    instance = await createStrapi().load();
    
    // Register the /api/hello test route automatically
    const contentApi = instance.server?.api?.('content-api');
    if (contentApi && !instance.__helloRouteRegistered) {
      const createHelloService = require(path.join(
        __dirname,
        '..',
        'src',
        'api',
        'hello',
        'services',
        'hello'
      ));
      const helloService = createHelloService({ strapi: instance });
```

--------------------------------

### Count users with curl and JSON response

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Sends a GET request to /api/users/count to get the total number of users. The response is a JSON number, as shown in the example output.

```bash
curl http://localhost:1337/api/users/count \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
```

```json
42
```

--------------------------------

### Get draft versions with status=draft

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/rest/status.md

Use the status=draft query parameter to retrieve draft versions of documents. The cURL example sends a GET request to /api/restaurants?status=draft with an Authorization header. The JavaScript example uses the qs library to build the query string with encodeValuesOnly set to true for a prettier URL.

```bash
curl 'http://localhost:1337/api/restaurants?status=draft' \
  -H 'Authorization: Bearer <token>'
```

```js
const qs = require('qs');
const query = qs.stringify({
    status: 'draft',
}, {
    encodeValuesOnly: true, // prettify URL
});

await request(`/api/restaurants?${query}`);
```

--------------------------------

### .env file with server, secrets, and database settings

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Example .env file with sections for server, secrets, and database configuration. Includes commented placeholders for optional database variables.

```env
# Server
HOST=0.0.0.0
PORT=1337

# Secrets
APP_KEYS=appkeyvalue1,appkeyvalue2,appkeyvalue3,appkeyvalue4
API_TOKEN_SALT=anapitokensalt
ADMIN_JWT_SECRET=youradminjwtsecret
TRANSFER_TOKEN_SALT=transfertokensaltvalue
ENCRYPTION_KEY=yourencryptionkey

# Database
DATABASE_CLIENT=sqlite
DATABASE_HOST=
DATABASE_PORT=
DATABASE_NAME=
DATABASE_USERNAME=
DATABASE_PASSWORD=
DATABASE_SSL=false
DATABASE_FILENAME=.tmp/data.db
```

--------------------------------

### GET /api/articles — Without populate

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Returns only default attributes for all articles. This example shows a curl command and a JavaScript fetch example, along with the JSON response structure.

```APIDOC
## GET /api/articles

### Description
Returns only default attributes for all articles.

### Method
GET

### Endpoint
/api/articles

### Parameters
#### Query Parameters
- **populate** (string) - Optional - Specifies which relations to populate. Example: `populate[0]=category`.

### Request Example
```bash
curl 'http://localhost:1337/api/articles' \
  -H 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **data** (array) - List of articles.
  - **id** (number) - Article ID.
  - **documentId** (string) - Document ID.
  - **title** (string) - Article title.
  - **slug** (string) - Article slug.
  - **createdAt** (string) - Creation timestamp.
  - **updatedAt** (string) - Last update timestamp.
  - **publishedAt** (string) - Publication timestamp.
  - **locale** (string) - Locale code.
  - **ckeditor_content** (string) - Content field.
- **meta** (object) - Pagination metadata.
  - **pagination** (object) - Pagination details.
    - **page** (number) - Current page.
    - **pageSize** (number) - Page size.
    - **pageCount** (number) - Total pages.
    - **total** (number) - Total items.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "documentId": "x2m0d7d9o4m2z3u2r2l9yes",
      "title": "Here's why you have to try basque cuisine, according to a basque chef",
      "slug": "here-s-why-you-have-to-try-basque-cuisine-according-to-a-basque-chef",
      "createdAt": "2021-11-09T13:33:19.948Z",
      "updatedAt": "2023-06-02T10:57:19.584Z",
      "publishedAt": "2022-09-22T09:30:00.208Z",
      "locale": "en",
      "ckeditor_content": "…"
    },
    {
      "id": 2,
      "documentId": "k6m6l9q0n6v9z2m3i0z5jah",
      "title": "What are chinese hamburgers and why aren't you eating them?",
      "slug": "what-are-chinese-hamburgers-and-why-aren-t-you-eating-them",
      "createdAt": "2021-11-11T13:33:19.948Z",
      "updatedAt": "2023-06-01T14:32:50.984Z",
      "publishedAt": "2022-09-22T12:36:48.312Z",
      "locale": "en",
      "ckeditor_content": "…"
    },
    {
      "id": 3,
      "documentId": "o5d4b0l4p8l4o4k5n1l3rxa",
      "title": "7 Places worth visiting for the food alone",
      "slug": "7-places-worth-visiting-for-the-food-alone",
      "createdAt": "2021-11-12T13:33:19.948Z",
      "updatedAt": "2023-06-02T11:30:00.075Z",
      "publishedAt": "2023-06-02T11:30:00.075Z",
      "locale": "en",
      "ckeditor_content": "…"
    },
    {
      "id": 4,
      "documentId": "t3q2i3v1z2j7o8p6d0o4xxg",
      "title": "If you don't finish your plate in these countries, you might offend someone",
      "slug": "if-you-don-t-finish-your-plate-in-these-countries-you-might-offend-someone",
      "createdAt": "2021-11-15T13:33:19.948Z",
      "updatedAt": "2023-06-02T10:59:35.148Z",
      "publishedAt": "2022-09-22T12:35:53.899Z",
      "locale": "en",
      "ckeditor_content": "…"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}
```
```

--------------------------------

### Start server in production (Yarn and npm)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Run these commands to start the Strapi server with production settings. Use the one matching your package manager.

```bash
NODE_ENV=production yarn start
```

```bash
NODE_ENV=production npm run start
```

--------------------------------

### Create .env file with placeholder values

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/installation/docker.md

Environment variables for server, database, secrets, and environment. Replace placeholders before starting containers.

```bash
# Server
HOST=0.0.0.0
PORT=1337

# Database
# Use 'mysql' for MySQL or MariaDB, and change DATABASE_PORT to 3306
DATABASE_CLIENT=postgres
DATABASE_HOST=strapiDB
DATABASE_PORT=5432
DATABASE_NAME=strapi
DATABASE_USERNAME=strapi
DATABASE_PASSWORD=strapi

# Secrets
APP_KEYS=toBeModified1,toBeModified2
API_TOKEN_SALT=tobemodified
ADMIN_JWT_SECRET=tobemodified
TRANSFER_TOKEN_SALT=tobemodified
JWT_SECRET=tobemodified
ENCRYPTION_KEY=tobemodified

# Environment
NODE_ENV=development
```

--------------------------------

### Get a single document - JSON response

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example JSON response for a successful GET request to /api/restaurants/{documentId}. Shows the document object with fields and an empty meta object.

```JSON
{
  "data": {
    "id": 6,
    "documentId": "znrlzntu9ei5onjvwfaalu2v",
    "Name": "Biscotte Restaurant",
    "Description": [
      {
        "type": "paragraph",
        "children": [{ "type": "text", "text": "Welcome to Biscotte restaurant! Restaurant Biscotte offers a cuisine based on fresh, quality products." }]
      }
    ],
    "createdAt": "2024-02-27T10:19:04.953Z",
    "updatedAt": "2024-03-05T15:52:05.591Z",
    "publishedAt": "2024-03-05T15:52:05.600Z",
    "locale": "en"
  },
  "meta": {}
}
```

--------------------------------

### useRBAC with array argument

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example of using useRBAC with an array argument to get allowedActions.

```tsx
const { allowedActions } = useRBAC([
  { action: 'admin::something.main', subject: null }
])

const canMain = allowedActions.canMain
```

--------------------------------

### Install Strapi Client with npm

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/client.md

Install the @strapi/client package using npm.

```bash
npm install @strapi/client
```

--------------------------------

### useRBAC with object argument

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example of using useRBAC with an object argument to get allowedActions.

```tsx
const { allowedActions } = useRBAC({
	main: [{ action: 'admin::something.main', subject: null }]
})

const canMain = allowedActions.canMain
```

--------------------------------

### Setup Strapi instance for testing

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-full.txt

Creates and loads a Strapi instance, registers a test /api/hello route, optionally seeds data, and patches the user service to assign the authenticated role by default. Returns the instance.

```javascript
async function setupStrapi() {
  if (!instance) {
    instance = await createStrapi().load();
    
    // Register the /api/hello test route automatically
    const contentApi = instance.server?.api?.('content-api');
    if (contentApi && !instance.__helloRouteRegistered) {
      const createHelloService = require(path.join(
        __dirname,
        '..',
        'src',
        'api',
        'hello',
        'services',
        'hello'
      ));
      const helloService = createHelloService({ strapi: instance });

      contentApi.routes([
        {
          method: 'GET',
          path: '/hello',
          handler: async (ctx) => {
            ctx.body = await helloService.getMessage();
          },
          config: {
            auth: false,
          },
        },
      ]);

      contentApi.mount(instance.server.router);
      instance.__helloRouteRegistered = true;
    }
    
    await instance.start();
    global.strapi = instance;

  // Optionally seed example data for tests if requested
  if (process.env.TEST_SEED === 'true') {
    try {
      const { seedExampleApp } = require(path.join(__dirname, '..', 'scripts', 'seed'));
      await seedExampleApp();
    } catch (e) {
      console.warn('Seeding failed:', e);
    }
  }

    // Patch the user service to automatically assign the authenticated role
    const userService = strapi.plugins['users-permissions']?.services?.user;
    if (userService) {
      const originalAdd = userService.add.bind(userService);

      userService.add = async (values) => {
        const data = { ...values };

        if (!data.role) {
          const defaultRole = await strapi.db
            .query('plugin::users-permissions.role')
            .findOne({ where: { type: 'authenticated' } });

          if (defaultRole) {
            data.role = defaultRole.id;
          }
        }

        return originalAdd(data);
      };
    }
  }
  return instance;
}
```

--------------------------------

### Build and verify plugin (NPM)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/plugins-development/create-a-plugin.md

Run these commands when ready to publish. They build the plugin and verify the output is valid for publishing.

```bash
npm run build && npm run verify
```

--------------------------------

### Get paginated list of files - start/limit response

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

JSON response for a paginated list of files using start and limit parameters. Shows pagination metadata with start and limit values.

```json
{
  "data": [
    // ...
  ],
  "meta": {
    "pagination": {
      "start": 20,
      "limit": 5
    }
  }
}
```

--------------------------------

### Install Strapi Client with Yarn

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/client.md

Install the @strapi/client package using Yarn.

```bash
yarn add @strapi/client
```

--------------------------------

### Example OpenAPI specification structure

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Shows the structure of a generated OpenAPI 3.1.0 specification, including info, paths, and components. The example includes a GET endpoint for /api/articles and an Article schema.

```json
{
  "openapi": "3.1.0",
  "x-powered-by": "strapi",
  "x-strapi-version": "5.21.0",
  "info": {
    "title": "My Strapi API",
    "description": "API documentation for My Strapi API",
    "version": "1.0.0"
  },
  "paths": {
    "/api/articles": {
      "get": {
        "operationId": "article/get/articles",
        "parameters": [
          {
            "name": "fields",
            "in": "query",
            "schema": {
              "type": "array",
              "items": { "type": "string" }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": { "$ref": "#/components/schemas/Article" }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Article": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "title": { "type": "string" },
          "content": { "type": "string" }
        }
      }
    }
  }
}
```

--------------------------------

### Configure server.js

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Example configuration for /config/server.js using environment variables to define host and port.

```js
module.exports = ({ env }) => ({
  host: env('HOST', '0.0.0.0'),
  port: env.int('PORT', 1337),
});
```

--------------------------------

### Example query: Pagination by offset

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/graphql.md

Demonstrates how to paginate results using the start and limit parameters.

```graphql
{
  restaurants_connection(pagination: { start: 10, limit: 19 }) {
    nodes {
      documentId
      name
    }
    pageInfo {
      page
      pageSize
      pageCount
      total
    }
  }
}
```

--------------------------------

### Get settings with strapi.store().get()

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/database.md

Retrieves a configuration value from the store. The store is created with environment, type, and name options, then get() is called with the key. The example uses the 'users-permissions' plugin store.

```javascript
// strapi.store(object).get(object);
// create reusable plugin store variable
const pluginStore = strapi.store({
  environment: strapi.config.environment,
  type: 'plugin',
  name: 'users-permissions',
});
await pluginStore.get({ key: 'grant' });
```

--------------------------------

### General help for the upgrade tool

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/upgrade-tool.md

Displays the global help information and lists all available commands and options for the upgrade tool.

```sh
$ npx @strapi/upgrade -h
Usage: upgrade <command> [options]

Options:
 -V, --version    output the version number
 -h, --help       Print command line options

Commands:
 latest [options]  Upgrade to the latest available version of Strapi
 major [options]   Upgrade to the next available major version of Strapi
 minor [options]   Upgrade to ...
 patch [options]   Upgrade to ...
to [options] <target> Upgrade to a specific version of Strapi
 help [command]    Print options for a specific command
```

--------------------------------

### Count documents with strapi.documents().count()

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/document-service.md

Examples of using the count() method to count documents matching parameters. The generic example counts all documents for the default locale. The 'Count published' example counts only published documents. The 'With filters' example counts draft documents (default status) in the default locale whose name starts with 'Pizzeria'.

```js
await strapi.documents('api::restaurant.restaurant').count()
```

```js
strapi.documents('api::restaurant.restaurant').count({ status: 'published' })
```

```js
/**
 * Count number of draft documents (default if status is omitted)
 * in English (default locale)
 * whose name starts with 'Pizzeria'
 */
strapi.documents('api::restaurant.restaurant').count({ filters: { name: { $startsWith: "Pizzeria" }}})
```

--------------------------------

### Build admin panel on Windows

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Setup and build commands for Windows environments using cross-env.

```bash
npm install --save-dev cross-env
```

```json
"build:win": "cross-env NODE_ENV=production npm run build",
```

```bash
npm run build:win
```

--------------------------------

### Start Strapi with NPM

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/installation/cli.md

Use this command in the project folder to start the Strapi application in development mode.

```bash
npm run develop
```

--------------------------------

### GET a document in a specific locale (collection type) (JSON response)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

Example JSON response for the GET /api/restaurants/:documentId?locale=fr request. Shows a single document with locale 'fr' and an empty meta object.

```json
{
  "data": {
    "id": 22,
    "documentId": "lr5wju2og49bf820kj9kz8c3",
    "Name": "Biscotte Restaurant",
    "Description": [
      {
        "type": "paragraph",
        "children": [
          {
            "type": "text",
            "text": "Bienvenue au restaurant Biscotte! Le Restaurant Biscotte propose une cuisine à base de produits frais et de qualité, souvent locaux, biologiques lorsque cela est possible, et toujours produits par des producteurs passionnés."
          }
        ]
      }
    ],
    "createdAt": "2024-03-06T22:08:59.643Z",
    "updatedAt": "2024-03-06T22:10:21.127Z",
    "publishedAt": "2024-03-06T22:10:21.130Z",
    "locale": "fr"
  },
  "meta": {}
}
```

--------------------------------

### Complete configuration example for /config/plugins.js

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/configurations/media-library-providers/amazon-s3.md

A complete configuration example for the AWS S3 provider, combining all extended options: checksum, conditional writes, storage class, encryption, tags, and multipart settings. Uses environment variables for sensitive values.

```javascript
module.exports = ({ env }) => ({
  upload: {
    config: {
      provider: 'aws-s3',
      providerOptions: {
        baseUrl: env('CDN_URL'),
        rootPath: env('CDN_ROOT_PATH'),
        s3Options: {
          credentials: {
            accessKeyId: env('AWS_ACCESS_KEY_ID'),
            secretAccessKey: env('AWS_ACCESS_SECRET'),
          },
          region: env('AWS_REGION'),
          params: {
            ACL: 'private',
            signedUrlExpires: 15 * 60,
            Bucket: env('AWS_BUCKET'),
          },
        },
        providerConfig: {
          checksumAlgorithm: 'CRC64NVME',
          preventOverwrite: true,
          storageClass: 'INTELLIGENT_TIERING',
          encryption: {
            type: 'aws:kms',
            kmsKeyId: env('AWS_KMS_KEY_ID'),
          },
          tags: {
            application: 'strapi',
            environment: env('NODE_ENV'),
          },
          multipart: {
            partSize: 10 * 1024 * 1024,
            queueSize: 4,
          },
        },
      },
    },
  },
});
```

--------------------------------

### GET /api/articles?pagination[start]=0&pagination[limit]=10

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/rest/sort-pagination.md

Paginate results by offset, specifying the starting entry and the number of entries to return. Returns a subset of entries with pagination metadata including total count.

```APIDOC
## GET /api/articles?pagination[start]=0&pagination[limit]=10

### Description
Paginate results by offset, specifying the starting entry and the number of entries to return. Returns a subset of entries with pagination metadata including total count.

### Method
GET

### Endpoint
/api/articles?pagination[start]=0&pagination[limit]=10

### Parameters
#### Query Parameters
- **pagination[start]** (Integer) - Optional - Start value (i.e. first entry to return). Default: 0.
- **pagination[limit]** (Integer) - Optional - Number of entries to return. Default: 25.
- **pagination[withCount]** (Boolean) - Optional - Toggles displaying the total number of entries to the response. Default: true.

### Request Example
```bash
curl 'http://localhost:1337/api/articles?pagination[start]=0&pagination[limit]=10' \
  -H 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **data** (array) - Array of entries.
- **meta.pagination.start** (Integer) - Start value used.
- **meta.pagination.limit** (Integer) - Number of entries returned.
- **meta.pagination.total** (Integer) - Total number of entries.

#### Response Example
```json
{
  "data": [
    // ...
  ],
  "meta": {
    "pagination": {
      "start": 0,
      "limit": 10,
      "total": 42
    }
  }
}
```
```

--------------------------------

### GraphQL filters: complex nested logical example (JSON)

Source: https://github.com/strapi/documentation/blob/main/docusaurus/static/llms-code.txt

A more complex filter combining and, not, and or operators. This example filters restaurants where averagePrice is not >= 20 and (name equals "Pizzeria" or starts with "Pizzeria").

```json
{
  restaurants(
    filters: {
      and: [
        { not: { averagePrice: { gte: 20 } } }
        {
          or: [
            { name: { eq: "Pizzeria" } }
            { name: { startsWith: "Pizzeria" } }
          ]
        }
      ]
    }
  ) {
    documentId
    name
    averagePrice
  }
}
```

--------------------------------

### Custom server.js entry point

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Create a ./server.js file to run the application using node instead of npm start.

```js
const strapi = require('@strapi/strapi');
strapi.createStrapi(/* {...} */).start();
```

--------------------------------

### Install Strapi Client with pnpm

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/api/client.md

Install the @strapi/client package using pnpm.

```bash
pnpm add @strapi/client
```

--------------------------------

### Start server with yarn

Source: https://github.com/strapi/documentation/blob/main/docusaurus/docs/cms/deployment.md

Command to start the production server using yarn.

```bash
NODE_ENV=production yarn start
```
Tokens:
Raw