Overriding default archibald configuration

Create local config file

When a new project is created from a template, there is a default configuration created. The default configuration can be found in the archibald.json file.

During the local development you might want to change some configuration. It could be cumbersome to work with the configuration directly in the archibald.json file because you don't want to commit it the changes to your source control management (SCM) system.

Fortunately Archibald allows you to override the configuration in the archibald.json file by defining configuration in the archibald.local.json file.

To override the default configuration you have to do the following:

1. Create the archibald.local.json file in the root directory of your project.

2. In the archibald.local.json file, use the schema from the archibald.json file to get the autocompletion.

{
    "$schema": "./node_modules/@archibald/cli/workspace/workspace-schema.json"
}

3. Start adding custom configuration to the archibald.local.json file. E.g., change the default port.

{
    "$schema": "./node_modules/@archibald/cli/workspace/workspace-schema.json",
    "cli": {
        "port": 4000
    }
}

4. Add the archibald.local.json file to the .gitignore file.