Shared Folders

Before we start

Complete the previous steps or the CLI Quickstart to ensure you can edit code both locally and in Quix Cloud.

Why use Shared Folders

Shared folders let you include additional directories when you build or deploy your Quix application, enabling code reuse and easier maintenance. For example, if multiple applications share common utility scripts, you can place them in a shared folder instead of duplicating the code in each project. This reduces redundancy and makes updates easier—changing a shared module automatically updates all applications that depend on it.

Default `app.yaml`

When you create a new application, you’ll have a default app.yaml like this:

app.yaml

name: sample
language: python
variables: []
dockerfile: dockerfile
runEntryPoint: main.py
defaultFile: main.py

For example, if your project has the following structure:

root
  ├─ .git
  ├─ sample
  │  ├─ app.yaml
  │  ├─ main.py
  │  ...
  └─ custom-modules
     ├─ __init__.py
     ...

Adding Folders in the Online IDE

Click the folder button

Select your folder

Tip

You can also edit app.yaml manually to add or remove folders.

Your app.yaml is now updated as follows:

app.yaml

name: sample
language: python
variables: []
dockerfile: dockerfile
runEntryPoint: main.py
defaultFile: main.py
includedFolders:
  - custom-modules

Confirmation

Whenever you deploy your application, run it in the online IDE, or execute it locally using the CLI, all directories listed under includedFolders will be bundled with your application to ensure they are available at runtime.

Warning

Make sure your Dockerfile is up-to-date if you’re updating an existing application. Refer to the dockerfile reference for details.