Strapi

https://docs.strapi.io/
Admin
Strapi is a headless CMS that enables developers to build any project in hours instead of weeks with...
Tokens:1,644,820
Snippets:11,941
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Scaffold a Strapi project with npx create-strapi

Source: https://docs.strapi.io

Scaffold, install, and start a new Strapi backend project in one command. Use the --quickstart flag for a minimal setup.

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

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

### GraphQL Plugin Setup

Source: https://docs.strapi.io/llms-code.txt

Installation and configuration of the GraphQL plugin.

```APIDOC
## Install GraphQL Plugin

### Description
Install the GraphQL plugin to enable the GraphQL API.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
yarn add @strapi/plugin-graphql
```

### Response
N/A
```

```APIDOC
## Install GraphQL Plugin (npm)

### Description
Install the GraphQL plugin using npm.

### Method
N/A

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
npm install @strapi/plugin-graphql
```

### Response
N/A
```

```APIDOC
## Configure GraphQL Plugin

### Description
Configure the GraphQL plugin in the plugins configuration file.

### Method
N/A

### Endpoint
N/A

### Parameters
- **shadowCRUD** (boolean) - Optional - Enable or disable shadow CRUD.
- **endpoint** (string) - Optional - The GraphQL endpoint path.
- **subscriptions** (boolean) - Optional - Enable or disable subscriptions.
- **maxLimit** (integer) - Optional - Maximum limit for queries.
- **apolloServer** (object) - Optional - Apollo Server configuration.
- **v4CompatibilityMode** (boolean) - Optional - Enable v4 compatibility mode.

### Request Example
```js
export default {
  shadowCRUD: true,
  endpoint: '/graphql',
  subscriptions: false,
  maxLimit: -1,
  apolloServer: {},
  v4CompatibilityMode: process.env.STRAPI_GRAPHQL_V4_COMPATIBILITY_MODE ?? false,
};
```

### Response
N/A
```

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

### Start Strapi server on Windows with cross-env

Source: https://docs.strapi.io/cms/deployment

For Windows environments, installs cross-env, adds a start:win script to package.json, and runs it to start the server with the production environment variable.

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

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

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

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

### Install better-sqlite3 for SQLite

Source: https://docs.strapi.io/cms/configurations/database

Installs the better-sqlite3 package for manual SQLite setup. Run one of these commands in a terminal.

```bash
yarn add better-sqlite3
```

```bash
npm install better-sqlite3
```

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

### Install documentation plugin with npm

Source: https://docs.strapi.io/cms/plugins/documentation

Install the documentation plugin using npm. Run this command in your terminal before starting Strapi to generate API documentation.

```terminal
npm install @strapi/plugin-documentation  
```

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

### Install documentation plugin with Yarn

Source: https://docs.strapi.io/cms/plugins/documentation

Install the documentation plugin using Yarn. Run this command in your terminal before starting Strapi to generate API documentation.

```terminal
yarn add @strapi/plugin-documentation  
```

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

### Create Strapi app with SQLite quickstart

Source: https://docs.strapi.io/cms/configurations/database

Creates a new Strapi project with SQLite as the default database and launches it in the browser. Use either command in a terminal.

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

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

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

### Example settings.json configuration

Source: https://docs.strapi.io/cms/plugins/documentation

Example configuration for the Documentation plugin. Create this file in `src/extensions/documentation/config` to set OpenAPI version, info, plugins, path, servers, external docs, and security. Custom keys must be prefixed with `x-`.

```json
{  
  "openapi": "3.0.0",  
  "info": {  
    "version": "1.0.0",  
    "title": "DOCUMENTATION",  
    "description": "",  
    "termsOfService": "YOUR_TERMS_OF_SERVICE_URL",  
    "contact": {  
      "name": "TEAM",  
      "email": "contact-email@something.io",  
      "url": "mywebsite.io"  
    },  
    "license": {  
      "name": "Apache 2.0",  
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"  
    }  
  },  
  "x-strapi-config": {  
    "plugins": ["upload", "users-permissions"],  
    "path": "/documentation"  
  },  
  "servers": [  
    {  
      "url": "http://localhost:1337/api",  
      "description": "Development server"  
    }  
  ],  
  "externalDocs": {  
    "description": "Find out more",  
    "url": "https://docs.strapi.io/developer-docs/latest/getting-started/introduction.html"  
  },  
  "security": [  
    {  
      "bearerAuth": []  
    }  
  ]  
}  
```

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

### Get files with offset pagination and filters

Source: https://docs.strapi.io/cms/api/rest/upload

Example request using offset pagination to get 5 image files, skipping the first 20, without a total count. Uses pagination[start], pagination[limit], pagination[withCount], and filters.

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

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

### Register and mount a test route in Strapi setup

Source: https://docs.strapi.io/llms-code.txt

Registers a GET /hello route with auth disabled, mounts it on the server router, starts the Strapi instance, and stores it globally for tests.

```javascript
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;
```

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

### Example .env file

Source: https://docs.strapi.io/cms/configurations/environment

Shows a typical .env file with server, secrets, and database settings. Includes placeholders for database connection parameters and SQLite filename.

```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/restaurants

Source: https://docs.strapi.io/llms-code.txt

This snippet documents the GET /api/restaurants endpoint with the publicationFilter=modified query parameter, including request examples in Bash and JavaScript, and response examples.

```APIDOC
## [GET] /api/restaurants

### Description
Finds documents that have been modified since their last publication. The `publicationFilter=modified` query parameter filters the results to only include modified documents.

### Method
GET

### Endpoint
/api/restaurants

### Parameters
#### Query Parameters
- **status** (string) - Optional - The status of the documents to filter by (e.g., `draft`).
- **publicationFilter** (string) - Required - Set to `modified` to retrieve modified documents.

### Request Example
```bash
curl 'http://localhost:1337/api/restaurants?status=draft&publicationFilter=modified' \
  -H 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **data** (array) - List of documents matching the filter.
  - **documentId** (string) - Unique identifier of the document.
  - **name** (string) - Name of the restaurant.
  - **publishedAt** (string or null) - Publication timestamp, `null` if not published.
  - **locale** (string) - Locale of the document.
- **meta** (object) - Pagination metadata.
  - **pagination** (object) - Pagination details.
    - **page** (number) - Current page number.
    - **pageSize** (number) - Number of items per page.
    - **pageCount** (number) - Total number of pages.
    - **total** (number) - Total number of items.

#### Response Example
```json
{
    "data": [
      {
        "documentId": "a1b2c3d4e5f6g7h8i9j0klm",
        "name": "Biscotte Restaurant (updated)",
        "publishedAt": null,
        "locale": "en"
      }
    ],
    "meta": {
      "pagination": {
        "page": 1,
        "pageSize": 25,
        "pageCount": 1,
        "total": 1
      }
    }
}
```
```

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

### Seed a default category in bootstrap() lifecycle

Source: https://docs.strapi.io/cms/configurations/functions

Seeds a default category during the bootstrap lifecycle. The bootstrap function runs after the application setup but before the server starts, so the full strapi object is available. This example checks for an existing category and creates one if none exists.

```js
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');
    }
  },
};
```

```ts

  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');
    }
  },
};
```

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

### Set up and run data transfer with --to and --from

Source: https://docs.strapi.io/assets/files/llms-code-747ff73f1a188670069dead4b80684fc.txt

Set up and run a data transfer. Start the Strapi server for the destination instance before running the transfer. Use --to to push data to a destination and --from to pull data from a remote source.

```Bash
yarn strapi transfer --to destinationURL
```

```Bash
npm run strapi transfer -- --to destinationURL
```

```Bash
yarn strapi transfer --from remoteURL
```

```Bash
npm run strapi transfer -- --from remoteURL
```

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

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

Source: https://docs.strapi.io/cms/plugins-development/create-a-plugin

Run this command in the parent directory where you want the plugin to be created. The path `my-strapi-plugin` can be replaced with any name or path. You will be guided through setup prompts.

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

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

### GET /api/:pluralApiId/:documentId - Response examples

Source: https://docs.strapi.io/assets/files/llms-full-20738ab8f84a3bf81afe726144e7cfdf.txt

Example responses for the GET request. The first shows a successful retrieval with document fields and metadata. The second shows a 404 error when the document is not found.

```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": {}
}
```

```json
{
  "data": null,
  "error": {
    "status": 404,
    "name": "NotFoundError",
    "message": "Not Found",
    "details": {}
  }
}
```

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

### npx @strapi/sdk-plugin init

Source: https://docs.strapi.io/cms/plugins-development/plugin-sdk

Creates a new plugin at a given path. Default path is ./src/plugins/my-plugin. Options include -d, --debug and --silent.

```terminal
npx @strapi/sdk-plugin init  
```

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

### GET /api/articles

Source: https://docs.strapi.io/assets/files/llms-code-747ff73f1a188670069dead4b80684fc.txt

Example of a GET request to /api/articles without the populate parameter, returning only default attributes.

```APIDOC
## [GET] /api/articles

### Description
Returns only default attributes, without any media fields, relations, components, or dynamic zones.

### Method
GET

### Endpoint
/api/articles

### Parameters
#### Query Parameters
- **populate** (string) - Optional - When omitted, only default attributes are returned.

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

### Response
#### Success Response (200)
- **data** (array) - List of article objects.
- **data[].id** (number) - Article ID.
- **data[].documentId** (string) - Document identifier.
- **data[].title** (string) - Article title.
- **data[].slug** (string) - Article slug.
- **data[].createdAt** (string) - Creation timestamp.
- **data[].updatedAt** (string) - Last update timestamp.
- **data[].publishedAt** (string) - Publication timestamp.
- **data[].locale** (string) - Locale code.
- **data[].ckeditor_content** (string) - Content field (truncated in example).
- **meta** (object) - Pagination metadata.
- **meta.pagination** (object) - Pagination details.
- **meta.pagination.page** (number) - Current page number.
- **meta.pagination.pageSize** (number) - Number of items per page.
- **meta.pagination.pageCount** (number) - Total number of pages.
- **meta.pagination.total** (number) - Total number of items.

#### Response 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"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}
```
```

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

### GET /api/posts

Source: https://docs.strapi.io/llms-code.txt

Example of making an authenticated GET request to the Strapi API using a JWT token.

```APIDOC
## [GET] /api/posts

### Description
Makes a permission-restricted API request using a JWT token obtained from login or registration.

### Method
GET

### Endpoint
/api/posts

### Parameters
#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **data** (object) - The response data from the API.

#### Response Example
{
  "data": {}
}
```

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

### Set up Strapi instance for testing

Source: https://docs.strapi.io/cms/testing

Creates and loads a Strapi instance, registers a test /hello route, optionally seeds data, and patches the users-permissions 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;
}
```

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

### GET /api/articles

Source: https://docs.strapi.io/assets/files/llms-full-20738ab8f84a3bf81afe726144e7cfdf.txt

Documentation for the GET /api/articles endpoint, including the default response and the populate query parameter example.

```APIDOC
## GET /api/articles

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

### Method
GET

### Endpoint
/api/articles

### Parameters
#### Query Parameters
- **populate[0]** (string) - Optional - Specifies a relation field to populate, e.g., `category`.

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

### Response
#### Success Response (200)
- **data** (array) - List of article objects.
- **data[].id** (number) - Unique identifier of the article.
- **data[].documentId** (string) - Document identifier of the article.
- **data[].title** (string) - Title of the article.
- **data[].slug** (string) - URL slug of the article.
- **data[].createdAt** (string) - Creation timestamp.
- **data[].updatedAt** (string) - Last update timestamp.
- **data[].publishedAt** (string) - Publication timestamp.
- **data[].locale** (string) - Locale of the article.
- **data[].ckeditor_content** (string) - Content of the article.
- **meta** (object) - Pagination metadata.
- **meta.pagination** (object) - Pagination details.
- **meta.pagination.page** (number) - Current page number.
- **meta.pagination.pageSize** (number) - Number of items per page.
- **meta.pagination.pageCount** (number) - Total number of pages.
- **meta.pagination.total** (number) - Total number of articles.

#### 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": "…"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 4
    }
  }
}
```
```

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

### Create a new Strapi project

Source: https://docs.strapi.io/cms/features/data-management/transfer-locally

Creates a new Strapi project with the quickstart flag. Replace <project-name> with your desired project name.

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

```

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

### GET /api/restaurants?status=draft

Source: https://docs.strapi.io/cms/api/rest/status

Example of using the status parameter in a GET request to retrieve draft versions of documents.

```APIDOC
## GET /api/restaurants?status=draft

### Description
Returns draft versions of documents by passing the `status=draft` query parameter.

### Method
GET

### Endpoint
/api/restaurants?status=draft

### Parameters
#### Query Parameters
- **status** (string) - Required - Set to `draft` to retrieve draft versions. Default is `published`.

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

### Response
#### Success Response (200)
- **data** (array) - List of documents.
- **data[].id** (number) - Document ID.
- **data[].documentId** (string) - Document identifier.
- **data[].Name** (string) - Name of the restaurant.
- **data[].Description** (array) - Rich text content.
- **data[].createdAt** (string) - Creation timestamp.
- **data[].updatedAt** (string) - Last update timestamp.
- **data[].publishedAt** (null) - Always null for drafts.
- **data[].locale** (string) - Locale code.
- **meta** (object) - Pagination metadata.
- **meta.pagination** (object) - Pagination details.
- **meta.pagination.page** (number) - Current page.
- **meta.pagination.pageSize** (number) - Items per page.
- **meta.pagination.pageCount** (number) - Total pages.
- **meta.pagination.total** (number) - Total items.

#### Response Example
```
{
  "data": [
    {
      "id": 5,
      "documentId": "znrlzntu9ei5onjvwfaalu2v",
      "Name": "Biscotte Restaurant",
      "Description": [
        {
          "type": "paragraph",
          "children": [
            {
              "type": "text",
              "text": "This is the draft version."
            }
          ]
        }
      ],
      "createdAt": "2024-03-06T13:43:30.172Z",
      "updatedAt": "2024-03-06T21:38:46.353Z",
      "publishedAt": null,
      "locale": "en"
    }
  ],
  "meta": {
    "pagination": {
      "page": 1,
      "pageSize": 25,
      "pageCount": 1,
      "total": 1
    }
  }
}
```
```

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

### Set up Strapi instance and register hello route

Source: https://docs.strapi.io/llms-code.txt

Creates and loads a Strapi instance once, then registers the /api/hello test route by requiring the hello service and calling it with the instance. Uses a flag to avoid duplicate registration.

```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 });
```

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

### Create and run a Strapi project

Source: https://docs.strapi.io/cms/getting-started

These commands create a new Strapi project and start the development server. The first command prompts you to log in or sign up, and a 30-day trial of the Growth plan is automatically applied. The second command starts the server and opens a new browser tab for registering the first local administrator user.

```terminal
npx create-strapi@latest my-strapi-project  
```

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

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

### Get paginated files with GET /api/upload/files/page

Source: https://docs.strapi.io/cms/api/rest/upload

Example request to get the second page of 10 files using the paginated endpoint. Uses nested pagination parameters.

```http
GET /api/upload/files/page?pagination[page]=2&pagination[pageSize]=10
```

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

### Start Strapi with PM2 and check logs

Source: https://docs.strapi.io/llms-code.txt

Start Strapi with PM2 using the ecosystem file, then list running processes and view the last 100 log lines for the strapi process.

```bash
pm2 start ecosystem.config.js
```

```bash
pm2 list
```

```bash
pm2 logs strapi --lines 100
```

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

### Paginate results with limit and start

Source: https://docs.strapi.io/llms-code.txt

Paginate results using the limit and start parameters. The example limits to 10 documents starting from offset 0 and shows the resulting documents.

```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"
  }
]
```

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

### Complete configuration example (/config/plugins.js)

Source: https://docs.strapi.io/cms/configurations/media-library-providers/amazon-s3

Full Strapi upload plugin configuration for AWS S3 with all extended provider options: checksum, conditional writes, storage class, KMS encryption, tags, and multipart settings.

```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,  
          },  
        },  
      },  
    },  
  },  
});  

```

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

### Start the Strapi console

Source: https://docs.strapi.io/cms/cli

Run the `strapi console` command to start the server and open a Node.js REPL. The REPL gives access to all Strapi APIs through the global `strapi` object. Close the REPL with Ctrl-C twice to gracefully stop the server.

```bash
strapi console
```

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

### Get current user response

Source: https://docs.strapi.io/cms/features/users-permissions/rest-api

Example response for the GET /api/users/me endpoint. Returns a bare JSON object (not wrapped in a data key).

```json
{
  "id": 1,
  "documentId": "x74detpqybxw0bn6ormua5g2",
  "username": "testuser1",
  "email": "user@example.com",
  "provider": "local",
  "confirmed": true,
  "blocked": false,
  "createdAt": "2024-03-15T10:00:00.000Z",
  "updatedAt": "2024-03-15T10:00:00.000Z",
  "publishedAt": "2024-03-15T10:00:00.000Z"
}
```

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

### Example .env.example file

Source: https://docs.strapi.io/cms/configurations/environment

Shows the default .env.example file generated by the Strapi CLI, containing auto-generated security keys and database settings. The variables might differ depending on options selected on project creation.

```env
HOST=0.0.0.0
PORT=1337
APP_KEYS="toBeModified1,toBeModified2"
API_TOKEN_SALT=tobemodified
ADMIN_JWT_SECRET=tobemodified
TRANSFER_TOKEN_SALT=tobemodified
JWT_SECRET=tobemodified
ENCRYPTION_KEY=tobemodified
```

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

### Paginate results with limit and start in strapi.documents().findMany()

Source: https://docs.strapi.io/cms/api/document-service/sort-pagination

Paginates results using the limit and start parameters. The example limits to 10 results starting at offset 0 and returns a 200 OK response.

```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"  
  }  
]  

```
Tokens:
Raw