Sylius

https://docs.sylius.com
Admin
Sylius is an open-source e-commerce platform built with Symfony, offering a modular architecture for...
Tokens:13,107
Snippets:227
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /public/getting-started.md

Source: https://docs.sylius.com/public/getting-started

Queries the documentation for information using natural language questions.

```APIDOC
## GET /public/getting-started.md

### Description
Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **response** (string) - Contains a direct answer to the question and relevant excerpts and sources from the documentation.
```

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

### Run Sylius installer

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Execute the interactive installation command in the project root.

```bash
bin/console sylius:install
```

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

### GET /public/getting-started/before-you-begin.md

Source: https://docs.sylius.com/public/getting-started/before-you-begin.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /public/getting-started/before-you-begin.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started/before-you-begin.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### GET /public/getting-started/sylius-ce-installation-with-docker.md

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /public/getting-started/sylius-ce-installation-with-docker.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Example translation file path

Source: https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

An example path for French admin UI translation strings.

```text
src/Sylius/AdminBundle/Resources/translations/messages.fr.yaml
```

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

### GET /public/getting-started/basic-configuration.md

Source: https://docs.sylius.com/public/getting-started/basic-configuration.md

Performs a dynamic query against the documentation to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /public/getting-started/basic-configuration.md

### Description
Queries the documentation dynamically to receive a direct answer, relevant excerpts, and sources based on a user question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started/basic-configuration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Example Polish translation file path

Source: https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

An example path for Polish translation files.

```text
src/Sylius/AdminBundle/Resources/translations/messages.pl.yaml
```

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

### GET /public/getting-started/sylius-ce-installation.md

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Performs a query against the documentation to retrieve information or context related to the current page.

```APIDOC
## GET /public/getting-started/sylius-ce-installation.md

### Description
Queries the documentation dynamically to retrieve an answer to a specific question, optionally tailored towards a broader end goal.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Querying documentation via HTTP GET

Source: https://docs.sylius.com/public/open-source/contributing/key-contributors.md

Perform an HTTP GET request to the documentation URL with query parameters to retrieve specific information.

```http
GET https://docs.sylius.com/public/open-source/contributing/key-contributors.md?ask=<question>&goal=<endgoal>
```

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

### GET /public/getting-started/payments.md

Source: https://docs.sylius.com/public/getting-started/payments.md

Queries the documentation page dynamically to retrieve answers based on a specific question and optional goal.

```APIDOC
## GET /public/getting-started/payments.md

### Description
Perform a dynamic query on the documentation page to retrieve information, clarifications, or related context.

### Method
GET

### Endpoint
https://docs.sylius.com/public/getting-started/payments.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### Build front-end assets

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Install dependencies and build assets using either npm or yarn.

```bash
npm install
npm run build
```

```bash
yarn install
yarn build
```

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

### Initialize and Open Sylius Environment

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Commands to start the development environment and open the application in the default browser.

```bash
make init
open http://localhost/
```

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

### Install specific Symfony version

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Ensure the correct Symfony version is installed before running the installer.

```bash
composer config extra.symfony.require "^7.0"
composer update
```

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

### GET /public/readme.md

Source: https://docs.sylius.com/public/readme.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer.

```APIDOC
## GET /public/readme.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/readme.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Request Example
GET https://docs.sylius.com/public/readme.md?ask=How+do+I+install+Sylius%3F&goal=setup+a+new+project

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

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

### Querying documentation via HTTP GET

Source: https://docs.sylius.com/public/getting-started/basic-configuration.md

Use this request format to ask specific questions and provide context for your end goal.

```http
GET https://docs.sylius.com/public/getting-started/basic-configuration.md?ask=<question>&goal=<endgoal>
```

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

### GET /public/open-source/release-cycle/backwards-compatibility-promise.md

Source: https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md

Queries the documentation page for information using a natural language question and an optional goal context.

```APIDOC
## GET /public/open-source/release-cycle/backwards-compatibility-promise.md

### Description
Queries the documentation dynamically by providing a specific question. This is useful for retrieving information not explicitly present on the page or for clarifying context.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Request Example
GET https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md?ask=What is the backwards compatibility policy?&goal=Upgrading Sylius version
```

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

### Querying Documentation via HTTP GET

Source: https://docs.sylius.com/public/getting-started/shipments.md

Use this request format to retrieve information from the documentation dynamically by providing a specific question and optional goal.

```http
GET https://docs.sylius.com/public/getting-started/shipments.md?ask=<question>&goal=<endgoal>
```

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

### GET /public/open-source/contributing/key-contributors.md

Source: https://docs.sylius.com/public/open-source/contributing/key-contributors.md

Queries the documentation page for information using a natural language question and an optional goal.

```APIDOC
## GET /public/open-source/contributing/key-contributors.md

### Description
Queries the documentation page for information using a natural language question and an optional goal.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/contributing/key-contributors.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /public/open-source/release-cycle.md

Source: https://docs.sylius.com/public/open-source/release-cycle.md

Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /public/open-source/release-cycle.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/release-cycle.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

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

### GET /public/open-source/contributing/contributing-code/sylius-license-and-trademark.md

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/sylius-license-and-trademark.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /public/open-source/contributing/contributing-code/sylius-license-and-trademark.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/contributing/contributing-code/sylius-license-and-trademark.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

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

### Querying documentation via HTTP GET

Source: https://docs.sylius.com/public/getting-started/payments.md

Use this request format to retrieve answers or context from the documentation when information is not explicitly found on the page.

```http
GET https://docs.sylius.com/public/getting-started/payments.md?ask=<question>&goal=<endgoal>
```

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

### Configure Port Mappings in compose.override.yml

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Example configuration for overriding default Docker port mappings to resolve conflicts.

```yaml
# examples

nginx:
  ports:
    - "8080:80"

mysql:
  ports:
    - "3307:3306"
```

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

### GET /public/open-source/contributing/contributing-code/submitting-a-patch.md

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Queries the documentation page for specific information using natural language questions and optional goal context.

```APIDOC
## GET /public/open-source/contributing/contributing-code/submitting-a-patch.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### GET /public/what-is-sylius/architecture.md

Source: https://docs.sylius.com/public/llms.txt

Performs a query against the documentation index to receive an answer based on a specific question and optional goal.

```APIDOC
## GET /public/what-is-sylius/architecture.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to retrieve a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.sylius.com/public/what-is-sylius/architecture.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

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

### GET /public/open-source/contributing/contributing-translations.md

Source: https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a provided question and optional goal.

```APIDOC
## GET /public/open-source/contributing/contributing-translations.md

### Description
Queries the documentation page dynamically to retrieve answers and relevant excerpts based on a provided question and optional goal.

### Method
GET

### Endpoint
https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

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

### GET /public/what-is-sylius.md

Source: https://docs.sylius.com/public/what-is-sylius

Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /public/what-is-sylius.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.sylius.com/public/what-is-sylius.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

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

### Create a new Sylius project

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Initialize a new project using the Sylius Standard template and navigate into the directory.

```bash
composer create-project sylius/sylius-standard AcmeStore
```

```bash
cd AcmeStore
```

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

### View Sylius Connect help documentation

Source: https://docs.sylius.com/ai-development-guide

Displays the help menu for the Sylius Connect CLI tool.

```bash
$ sylius connect –help
```

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

### Clone the Sylius-Standard repository

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Use this command to initialize your project by cloning the official Sylius-Standard template repository.

```bash
git clone git@github.com:Sylius/Sylius-Standard.git your_project_name
```

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

### Connect to Sylius services via CLI

Source: https://docs.sylius.com/ai-development-guide

Initiates an interactive session to connect your account to Sylius services.

```bash
$ sylius connect --interactive
```

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

### Querying Documentation via HTTP

Source: https://docs.sylius.com/public/getting-started/first-product.md

Use this request format to ask specific questions about the documentation when information is not explicitly available on the current page.

```http
GET https://docs.sylius.com/public/getting-started/first-product.md?ask=<question>&goal=<endgoal>
```

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

### Run Messenger Consumer

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Execute the messenger consumer command to process asynchronous tasks like Catalog Promotions.

```bash
 php bin/console messenger:consume main
```

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

### Create a Topic Branch

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Initializes a new feature branch based on the upstream target branch.

```bash
git switch upstream/2.2 -c feature_branch
```

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

### Open Application on Custom Port

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Command to access the application when the NGINX port has been remapped.

```bash
open http://localhost:8080 # for the example above
```

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

### Define database connection

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Set the database connection string in the .env.local file for different database engines.

```sh
DATABASE_URL=mysql://<username>:<password>@<host>/<your_database_name>_%kernel.environment%?serverVersion=<your_db_version>&charset=utf8
```

```sh
DATABASE_URL=mysql://<username>:<password>@<host>/<your_database_name>_%kernel.environment%?serverVersion=mariadb-<your_db_version>&charset=utf8
```

```sh
DATABASE_URL=pgsql://<username>:<password>@<host>/<your_database_name>_%kernel.environment%?serverVersion=<your_db_version>&charset=utf8
```

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

### Clone and Configure Repository

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Commands to clone a fork and add the main Sylius repository as an upstream remote.

```bash
git clone git@github.com:YOUR_USERNAME/Sylius.git
```

```bash
cd Sylius
git remote add upstream git://github.com/Sylius/Sylius.git
```

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

### Configure Symfony version

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Update the project configuration to use a specific Symfony version.

```bash
composer config extra.symfony.require "<version>" # e.g. "6.3.*"
composer update
```

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

### Check coding standards with ECS

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/coding-standards.md

Run this command to verify that the source code and tests adhere to the project's coding standards.

```bash
vendor/bin/ecs check src tests
```

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

### Configure Git Line Endings

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Sets the core.autocrlf configuration to input to handle line endings correctly on Windows.

```bash
git config core.autocrlf input
```

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

### Rebase and Squash Commits

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Commands for rebasing against the base branch and performing interactive squashing of commits.

```bash
git rebase -f upstream/2.2
git push --force-with-lease origin feature_branch
```

```bash
git rebase -i upstream/2.2
```

```bash
git push --force-with-lease origin feature_branch
```

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

### Translation file path pattern

Source: https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

The general directory structure for locating translation files within bundles.

```text
src/Sylius/*Bundle/Resources/translations/messages.{locale}.yaml
```

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

### Pull Request Checklist Template

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

The required table format for the pull request description.

```markdown
| Q               | A
| --------------- | -----
| Branch?         | {lowest_bugfix_version} or {future_version}
| Bug fix?        | no/yes
| New feature?    | no/yes
| BC breaks?      | no/yes
| Deprecations?   | no/yes
| Related tickets | fixes #X, partially #Y, mentioned in #Z
| License         | MIT
```

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

### Check Port Usage

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation-with-docker.md

Commands to identify processes currently occupying specific network ports.

```bash
lsof -i :80
lsof -i :3306
```

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

### Configure Mailer URL

Source: https://docs.sylius.com/public/getting-started/sylius-ce-installation.md

Set the mailer transport configuration in the .env file for deprecated SwiftMailer usage.

```bash
MAILER_URL=gmail://username:password@local
```

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

### Configure Git Identity

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Sets the global user name and email for Git commits.

```bash
git config --global user.name "Your Name"
git config --global user.email "you@example.com"
```

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

### Push Changes to Fork

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Pushes local branch changes to the remote fork using force-with-lease for safety.

```bash
git push --force-with-lease origin feature_branch
```

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

### Translation file naming convention

Source: https://docs.sylius.com/public/open-source/contributing/contributing-translations.md

The standard naming pattern for translation files in Sylius.

```text
messages.{locale}.yaml
```

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

### Rebase and Resolve Conflicts

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/submitting-a-patch.md

Commands to update a branch with the latest upstream changes and resolve merge conflicts.

```bash
git checkout feature_branch
git rebase upstream/2.2  # or upstream/2.1 for bug fixes
```

```bash
git add resolved_file
git rebase --continue
```

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

### Marking code as deprecated with PHPDoc

Source: https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md

Use this annotation to signal that a class, method, or property is deprecated and provide a replacement.

```php
/**
 * @deprecated Deprecated since version 1.X. Use XXX instead.
 */
```

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

### Fix coding standard violations

Source: https://docs.sylius.com/public/open-source/contributing/contributing-code/coding-standards.md

Automatically resolve fixable coding standard violations by appending the --fix flag.

```bash
vendor/bin/ecs check src tests --fix
```

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

### Triggering a PHP deprecation

Source: https://docs.sylius.com/public/open-source/release-cycle/backwards-compatibility-promise.md

Use the trigger_deprecation function to notify developers of upcoming removals during runtime.

```php
trigger_deprecation(
    'sylius/some-package', // package name
    '1.x', // package version
    'A is deprecated and will be removed in Sylius 2.0. Use B instead.', // message
);
```
Tokens:
Raw