> ## Documentation Index
> Fetch the complete documentation index at: https://developer.upsun.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Making .upsun/config.yaml easier to edit with IDE autocomplete and validation

> Boost your productivity and eliminate configuration errors with real-time autocompletion and validation for your .upsun/config.yaml — discover how to enhance your IDE experience in just a few simple steps!  
  


Working with `.upsun/config.yaml` files can be tedious if your editor doesn’t help you catch errors early or suggest valid keys as you type.
Fortunately, you can get schema-based validation and autocompletion in popular editors like VSCode and PhpStorm — making your configuration faster, safer, and less error-prone.

In this article, we’ll show you how to set up this support using the official Upsun schema from [SchemaStore.org](https://www.schemastore.org/),
which IDEs like PhpStorm can automatically detect: [upsun.json](https://raw.githubusercontent.com/platformsh/platformify/refs/heads/main/validator/schema/upsun.json) schema

With just a few steps, you’ll get autocomplete for YAML config keys, inline documentation, and real-time error highlighting — all from your editor.

Let’s dive in! 🛠️

## Schema Available on SchemaStore

The [validation schema for `.upsun/config.yaml`](https://raw.githubusercontent.com/platformsh/platformify/refs/heads/main/validator/schema/upsun.json) is published on [SchemaStore](https://www.schemastore.org/), a centralized catalog of widely used JSON and YAML schemas.

Because it’s listed on SchemaStore:

* most IDEs, like [**VSCode**](https://code.visualstudio.com/), [**PhpStorm**](https://www.jetbrains.com/phpstorm/), [**WebStorm**](https://www.jetbrains.com/webstorm/), and [**IntelliJ IDEA**](https://www.jetbrains.com/idea/) (complete list [here](https://www.schemastore.org/#editors)), automatically detect and apply the schema when you open a `.upsun/config.yaml`.
* You benefit from autocompletion, inline errors, and context-aware editing — out of the box.

## Result with VSCode

> [!NOTE]
>
> If you're using Visual Studio Code, consider installing the [**Upsun VSCode extension**](https://marketplace.visualstudio.com/items?itemName=Upsun.upsun).
> It brings powerful features, including:
>
> * Schema-based autocompletion
> * Real-time configuration validation
> * Helpful inline documentation on hover
> * Project-aware interactions (more on this in an [upcoming blog post](https://developer.upsun.com/posts/releases/vscode-extension))
>
> Just install it from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=Upsun.upsun) and start editing your `.upsun/config.yaml` — no extra setup required.

### Autocomplete

If you’re unsure which settings are available at any level, just start typing — or press Ctrl+Space (or Cmd+Space on macOS) — to see a list of available parameters.

![Type less, discover more: Autocomplete every valid setting](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/vscode-autocomplete.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=e2772d26543116a63ea559fa7c3d3a38)

And see possible values instantly:

![Let your IDE guide you: Autocomplete for fixed values](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/vscode-autocomplete-values.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=77ee085ac7abe47d197acd8e9d37c4e5)

### Info on settings

When you hover your mouse over any YAML setting, helpful information and documentation links are displayed.

![Get instant info and documentation on any Upsun YAML setting](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/vscode-info.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=fc4f77d0c1fcc3719b2f49d0e8c6c51c)

### Deprecated settings

As our product evolves, some settings have been deprecated and are now marked with an orange underline.
Hover your mouse over the setting to see a tooltip with helpful information about the deprecation and suggested alternatives.

![Deprecated settings are clearly marked](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/vscode-deprecated.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=d169824e3c378468fd55e8aa1b1794c1)

## Result with PhpStorm

> [!NOTE]
>
> Using PhpStorm, to ensure you're always using the latest version of the configuration schema,
> enable the **Always download the most recent versions of schemas** option under
> `Settings > Languages & Frameworks > Schemas and DTDs > Remote JSON Schemas`:
>
> ![PhpStorm settings dialog showing Remote JSON Schemas configuration](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/phpstorm-settings.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=111cbabe9bff0d2ac660775c65189038)
>
> After enabling this option, restart your IDE to refresh all cached schemas.

### Autocomplete

If you’re unsure which settings are available at any level, just start typing — or press Ctrl+Space (or Cmd+Space on macOS) — to see a list of available parameters.

![Type less, discover more: Autocomplete every valid setting](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/phpstorm-autocomplete.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=5b1efb6477a908d1a0209a3e97334f6e)

And see possible values instantly:

![Let your IDE guide you: Autocomplete for fixed values](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/phpstorm-autocomplete-values.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=6808f71eacedb18149d4d6368842a636)

### Info on settings

When you hover your mouse over any YAML setting, helpful information and documentation links are displayed.

![Get instant info and documentation on any Upsun YAML setting](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/phpstorm-info.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=f7d5427bd16e8994e7715fc793bc4599)

### Deprecated settings

As our product evolves, some settings have been deprecated and are now marked with an orange underline.
Hover your mouse over the setting to see a tooltip with helpful information about the deprecation and suggested alternatives.

![Deprecated settings are clearly marked](https://mintcdn.com/upsun-c9761871/eXV27YLeu5lESGxN/images/posts/how-tos/validate-yaml-config/phpstorm-deprecated.webp?fit=max\&auto=format\&n=eXV27YLeu5lESGxN\&q=85\&s=fd333bca267270f206d5284be9abf53a)

## Best practices

* Always validate your config before committing or deploying.
* If you're using CI/CD, consider adding schema validation as a pre-check.
* Keep your IDE schema mappings up to date — most modern IDEs do this automatically.

With the right tools in place, validating `.upsun/config.yaml` becomes seamless — and ensures your configuration is always predictable, stable, and ready for production.

**Happy deploying!** 🚀

If you need assistance with setting up validation in your specific IDE or integrating it into your CI/CD pipeline, feel free to reach out on the [Upsun Community Forum](https://community.upsun.com/).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.