### Example: Get Help for setup:install Command

Source: https://github.com/magento/devdocs/blob/master/src/_includes/install/cli_help-commands.md

This is an example of how to get help for the `setup:install` command, showing its specific usage and options.

```bash
bin/magento help setup:install
```

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

### Example Composer Theme Installation

Source: https://github.com/magento/devdocs/blob/master/src/cloud/howtos/custom-theme.md

An example command for installing the 'fashionista-theme' using Composer.

```bash
composer require zero1/theme-fashionista-theme:1.0.0

```

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

### PHP Installation Confirmation Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/prereq/php-settings.md

This is an example output when PHP is successfully installed. It shows the PHP version, Zend Engine details, and OPcache information.

```terminal
PHP 7.3.0 (cli) (built: Aug 14 2019 16:42:46) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.1.0, Copyright (c) 1998-2018 Zend Technologies with Zend OPcache v7.1.6, Copyright (c) 1999-2018, by Zend Technologies
```

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

### Start and End Setup Execution

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/howdoi/custom-attributes/text-field.md

Use these methods to start and end the setup execution, which turns off foreign key checks and sets the SQL mode. Attribute creation code must be placed between these calls.

```php
$this->moduleDataSetup->getConnection()->startSetup();

/*
  Attribute creation code must be run between these two lines
  to ensure that the attribute is created smoothly.
 */

$this->moduleDataSetup->getConnection()->endSetup();
```

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

### Install Magento with admin credentials

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/install/cli/install-cli-install.md

Example of installing Magento and setting up admin user credentials. All admin credential variables are required if creating the user during installation.

```bash
magento setup:install \
--admin-firstname=John \
--admin-lastname=Doe \
--admin-email=john.doe@example.com \
--admin-user=admin \
--admin-password='YourSecurePassword123'
```

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

### Install Magento with Composer

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/composer.md

Use the command line to install Magento. This example shows a typical installation with database, admin, and search engine configurations.

```bash
bin/magento setup:install \
--base-url=http://localhost/magento2ee \
--db-host=localhost \
--db-name=magento \
--db-user=magento \
--db-password=magento \
--admin-firstname=admin \
--admin-lastname=admin \
--admin-email=admin@admin.com \
--admin-user=admin \
--admin-password=admin123 \
--language=en_US \
--currency=USD \
--timezone=America/Chicago \
--use-rewrites=1 \
--search-engine=elasticsearch7 \
--elasticsearch-host=es-host.example.com \
--elasticsearch-port=9200 \
--elasticsearch-index-prefix=magento2 \
--elasticsearch-timeout=15
```

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

### InstallSchema.php Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/extension-dev-guide/prepare/lifecycle.md

Implement this class to perform initial schema installation when a module is first installed. Magento skips this if the module is already installed.

```php
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace VendorName\ModuleName\Setup;

use Magento\Framework\Setup\InstallSchemaInterface;

class InstallSchema implements InstallSchemaInterface
{
    /**
     * @inheritdoc
     */
    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        //Install schema logic
    }
}
```

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

### Example PHP Version Output

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/prereq/php-settings.md

This is an example of the output you should expect when verifying PHP installation. It confirms PHP is installed and shows the version details.

```terminal
PHP 7.4.0 (cli) (built: Aug 14 2019 16:42:46) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.1.0, Copyright (c) 1998-2018 Zend Technologies with Zend OPcache v7.1.6, Copyright (c) 1999-2018, by Zend Technologies
```

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

### Example: Get Help for cache:enable Command

Source: https://github.com/magento/devdocs/blob/master/src/_includes/install/cli_help-commands.md

This is an example of how to get help for the `cache:enable` command, demonstrating how to access information about cache management commands.

```bash
bin/magento help cache:enable
```

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

### Magento Module Data Installation Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/extension-dev-guide/prepare/lifecycle.md

Implement the InstallDataInterface to populate the database with initial data during module installation. This class is executed only on the initial install.

```php
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace VendorName\ModuleName\Setup;

use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\ModuleContextInterface;

class InstallData implements InstallDataInterface
{
    /**
     * @inheritDoc
     */
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        // Data install logic
    }
}
```

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

### Install Magento with custom backend frontname

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/install/cli/install-cli-install.md

Example of installing Magento and specifying a custom URI for accessing the Admin panel. Using a random URI is recommended for security.

```bash
magento setup:install \
--backend-frontname=admin_customuri \
--base-url=http://127.0.0.1/magento2/ \
--db-name=magento2 \
--db-user=root \
--db-password='YourDbPassword'
```

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

### Install Magento with site and database configuration

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/install/cli/install-cli-install.md

Example of installing Magento with essential site and database configuration options. Ensure to enclose values with spaces or special characters in quotes.

```bash
magento setup:install \
--base-url=http://127.0.0.1/magento2/ \
--db-name=magento2 \
--db-user=root \
--db-password='YourDbPassword'
```

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

### Install Data Migration Tool 2.2.0 from GitHub

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/migration/migration-tool-install.md

Example command to install a specific version (2.2.0) of the Data Migration Tool from its GitHub repository.

```bash
composer config repositories.data-migration-tool git https://github.com/magento/data-migration-tool
composer require magento/data-migration-tool:2.2.0
```

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

### Start and End Setup Execution

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/howdoi/custom-attributes/text-field.md

Use startSetup() and endSetup() to manage database operations and ensure smooth attribute creation.

```php
$this->moduleDataSetup->getConnection()->startSetup();

    /*
      Attribute creation code must be run between these two lines
      to ensure that the attribute is created smoothly.
     */

    $this->moduleDataSetup->getConnection()->endSetup();
```

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

### Magento Setup Install Command Format

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/install/cli/install-cli-install.md

This is the general format for the Magento setup:install command, showing placeholders for options and their values.

```bash
bin/magento setup:install --<option>=<value> ... --<option>=<value>
```

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

### Example: Enable Virtual Host (Ubuntu)

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/config-guide/bootstrap/magento-how-to-set.md

Example command to enable a specific virtual host configuration file named 'my.magento.conf' on Ubuntu.

```bash
a2ensite my.magento.conf
```

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

### Example: Creating a Theme with Options and Arguments

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/extension-dev-guide/cli-cmds/cli-naming-guidelines.md

Illustrates using the `--parent` option to specify a parent theme, along with required arguments for theme creation.

```bash
bin/magento dev:theme:create --parent=Magento/luma frontend arg1 arg2
```

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

### Connect to MySQL Database (Starter Plan)

Source: https://github.com/magento/devdocs/blob/master/src/cloud/project/services-mysql.md

Connect to the MySQL database for Starter plan environments using the internal hostname and username.

```bash
mysql -h database.internal -u <username>
```

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

### Example GraphQL GET Request URL for Caching

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/graphql/caching.md

This example demonstrates the format of a GraphQL GET request URL that Fastly will cache. It includes the `query` parameter and `variables` in the URL.

```text
http://example.com/graphql?query={ products(filter: {sku: {eq: "Test"}}) { items { name } } }&variables={}
....
```

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

### Install sample data using the command line

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/comp-mgr/cli/cli-rc1-samp.md

This command installs sample data for Magento using the command-line interface. Ensure you are in the Magento root directory before execution.

```bash
bin/magento setup:upgrade --sample-data-import
```

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

### GET Endpoint Response Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/ext-best-practices/tutorials/create-custom-rest-api.md

This is an example of a successful JSON response when querying a product using the custom GET endpoint. It includes product details like ID, SKU, name, and description.

```json
{
    "id": 1,
    "sku": "24-MB01",
    "name": "Joust Duffle Bag",
    "description": "<p>The sporty Joust Duffle Bag can't be beat - not in the gym, not on the luggage carousel, not anywhere. Big enough to haul a basketball or soccer ball and some sneakers with plenty of room to spare, it's ideal for athletes with places to go.<p>\n<ul>\n<li>Dual top handles.</li>\n<li>Adjustable shoulder strap.</li>\n<li>Full-length zipper.</li>\n<li>L 29\" x W 13\" x H 11\".</li>\n</ul>"
}
```

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

### Example config.xml with Password and Prefix

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/migration/migration-tool-configure.md

This example shows how to include database passwords and table prefixes in the config.xml for both source and destination.

```xml
<source>
      <database host="127.0.0.1" name="magento1" user="root" password="pass"/>
   </source>
   <destination>
      <database host="127.0.0.1" name="magento2" user="root" password="pass"/>
   </destination>
   <options>
      <source_prefix>magento1</source_prefix>
      <crypt_key>f3e25abe619dae2387df9fs594f01985</crypt_key>
   </options>
```

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

### Example of Importing Database

Source: https://github.com/magento/devdocs/blob/master/src/cloud/setup/first-time-setup-import-import.md

An example demonstrating how to import a database using specific host, user, and database name values.

```bash
zcat var/db.sql.tgz | sed -e 's/DEFINER[ ]*=[ ]*[^*]*
*/
*/' | mysql -h database.internal -p -u user main
```

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

### Set Ownership Example for Ubuntu

Source: https://github.com/magento/devdocs/blob/master/src/_includes/install/sampledata/sample-data-clone-24.md

Example of setting ownership for the sample data repository on Ubuntu.

```bash
chown -R :www-data .
```

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

### Update Magento Setup After Installing Sample Data

Source: https://github.com/magento/devdocs/blob/master/src/_includes/install/sampledata/sample-data-clone-24.md

If installing sample data after Magento is already installed, this command is necessary to update the database and schema.

```bash
<magento_root>/bin/magento setup:upgrade
```

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

### Example GraphQL GET Request URL for Caching

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/graphql/caching.md

This is an example of a GraphQL query structured as a GET request URL, which Fastly's default VCL configuration will cache. It includes the query and variables in the URL parameters.

```http
http://example.com/graphql?query={ products(filter: {sku: {eq: "Test"}}) { items { name } } }&variables={}
```

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

### module.xml with Setup Version

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/ext-best-practices/extension-coding/example-module-adminpage.md

Includes the setup_version attribute, which is required if the module does not implement Declarative Schema.

```xml
<module name="MyCompany_ExampleAdminNewPage" setup_version="1.0.0">
```

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

### Install NTP on CentOS

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/install-gde/prereq/optional.md

Install the NTP package on CentOS systems using yum. This command ensures NTP is installed and configured to start on server boot.

```bash
yum -y install ntp.x86_64
```

```bash
chkconfig ntpd on
```

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

### Back up File System and Database

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/install/cli/install-cli-backup.md

Example of backing up both the Magento file system and the database using the setup:backup command.

```bash
bin/magento setup:backup --code --db
```

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

### Install Magento Sample Data

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/config-guide/cli/config-cli-subcommands.md

Installs optional sample data for Magento after the initial application installation.

```bash
magento sampledata:install
```

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

### GraphQL Query Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/graphql/send-request.md

This is an example of a GraphQL query to retrieve product information. It can be sent as a GET or POST request.

```graphql
{ products( filter: { sku: { eq: "24-WB01" } } ) {
    items {
      name
      sku
    }
  }
}
```

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

### Install Specific Quality Patch of Magento Enterprise Edition

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/composer.md

To install a specific quality patch, append the version number to the metapackage name. This example installs version 2.3.4.

```bash
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.4 <install-directory-name>
```

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

### Install Specific Minor Release of Magento Enterprise Edition

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/composer.md

To install a specific minor release, append the version number to the metapackage name. This example installs version 2.4.0.

```bash
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.4.0 <install-directory-name>
```

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

### Example Out of Memory Error Message

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/comp-mgr/trouble/cman/out-of-memory.md

This is an example of the error message you might see when the system runs out of memory during a Magento update or installation.

```terminal
Could not complete update {"components":[
{"name":"magento/module-bundle-sample-data","version":"100.1.0"}
]} successfully: proc_open(): fork failed - Cannot allocate memory
```

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

### SSH into Starter and Pro Integration Environments

Source: https://github.com/magento/devdocs/blob/master/src/cloud/howtos/debug.md

Use this command to SSH into Starter and Pro Integration environments. Replace `<environment-ID>` with your specific environment ID.

```bash
magento-cloud environment:ssh --pipe -e <environment-ID>
```

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

### RecurringData.php Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.4/extension-dev-guide/prepare/lifecycle.md

Implement this class for final database modifications after any data installation or upgrade stage. It implements the InstallDataInterface and its install() method.

```php
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace VendorName\ModuleName\Setup;

use Magento\Framework\Setup\InstallDataInterface;

class RecurringData implements InstallDataInterface
{
    /**
     * @inheritdoc
     */
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        // Recurring data event logic
    }
}
```

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

### Example: Customizing Magento Initialization Parameters

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/install/cli/install-cli-subcommands-store.md

This example demonstrates how to customize Magento initialization parameters, such as setting the Magento mode to developer and specifying custom directory paths for base and cache.

```bash
bin/magento setup:store-config:set --magento-init-params="MAGE_MODE=developer&MAGE_DIRS[base][path]=/var/www/example.com&MAGE_DIRS[cache][path]=/var/tmp/cache"
```

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

### Start MySQL Service on Ubuntu 16

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/prereq/mysql.md

Starts the MySQL service on Ubuntu 16. This command is essential after installation to make the database accessible.

```bash
sudo service mysql start
```

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

### Install Magento using the Command Line

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/composer.md

Use this command to install Magento, specifying database credentials, admin user details, and other essential configurations. Customize options like base URL and language as needed.

```bash
bin/magento setup:install \
--base-url=http://localhost/magento2ee \
--db-host=localhost \
--db-name=magento \
--db-user=magento \
--db-password=magento \
--admin-firstname=admin \
--admin-lastname=admin \
--admin-email=admin@admin.com \
--admin-user=admin \
--admin-password=admin123 \
--language=en_US \
--currency=USD \
--timezone=America/Chicago \
--use-rewrites=1
```

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

### Example SQL script execution

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/config-guide/multi-master/multi-master_manual.md

Illustrates how to execute a specific SQL script for foreign key setup.

```shell
source /root/sql-scripts/1_foreign-sales.sql
```

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

### Get Tier Prices Response Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/rest/modules/catalog-pricing.md

Example response when retrieving tier prices, showing active tier prices for specified SKUs.

```json
[
    {
        "price": 8,
        "price_type": "fixed",
        "website_id": 0,
        "sku": "24-UG04",
        "customer_group": "General",
        "quantity": 5
    },
    {
        "price": 6,
        "price_type": "fixed",
        "website_id": 0,
        "sku": "24-UG04",
        "customer_group": "General",
        "quantity": 10
    },
    {
        "price": 10,
        "price_type": "fixed",
        "website_id": 0,
        "sku": "24-UG04",
        "customer_group": "General",
        "quantity": 3
    },
    {
        "price": 5,
        "price_type": "discount",
        "website_id": 0,
        "sku": "24-UG01",
        "customer_group": "General",
        "quantity": 3
    }
]
```

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

### Example: Switch to Magento User

Source: https://github.com/magento/devdocs/blob/master/src/_includes/install/file-system-perms-before.md

An example demonstrating how to switch to a user named 'magento_user' using the 'su' command.

```bash
su magento_user
```

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

### Install Specific Security Patch of Magento Enterprise Edition

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/install-gde/composer.md

To install a specific security patch, use the Composer naming convention `2.3.2-px` and append it to the metapackage name. This example installs version 2.3.2-p1.

```bash
composer create-project --repository-url=https://repo.magento.com/ magento/project-enterprise-edition=2.3.2-p1 <install-directory-name>
```

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

### Example: Dump Shared Configuration

Source: https://github.com/magento/devdocs/blob/master/src/_includes/config/split-deploy/example_save-shared-config.md

An example of changing the directory and dumping the shared configuration.

```bash
cd /var/www/html/magento2
php bin/magento app:config:dump
```

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

### GraphQL Query Example

Source: https://github.com/magento/devdocs/blob/master/src/guides/v2.3/graphql/send-request.md

This is an example of a GraphQL query that can be sent as either a GET or POST request. It retrieves product information based on a SKU filter.

```graphql
{ products(filter: { sku: { eq: "24-WB01" } }) {
    items {
      name
      sku
    }
  }
}
```

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

### Example: Enable GitHub Integration for Personal Repository

Source: https://github.com/magento/devdocs/blob/master/src/cloud/integrations/github-integration.md

This example demonstrates enabling the GitHub integration for a personal GitHub repository. Ensure you replace `<token>` with your actual GitHub personal access token.

```bash
magento-cloud integration:add --type=github --project=ov58dlacU2e --token=<token> --repository=myUserName/myrepo
```