Information for: DEVELOPERS   PARTNERS

Settings and preferences

Cloud IDE is a modern and flexible platform that can be fully customized to suit your development needs.

Edit preferences

To edit your preferences, including your Cloud IDE user or workspace settings, complete the following steps:

  1. Visit your IDE from the Cloud Platform user interface or by running the following Acquia CLI command in your terminal:

    acli ide:open
    

    Note

    You might be requested to Sign in to the Cloud Platform user interface

  1. After you are redirected to your IDE, click File > Settings > Open Preferences.

  2. Identify the section containing the setting that you want to edit, and then click the section header to display all possible values.

  3. Change the desired setting.

    The following screen shows an example setting:

    Theia Settings

    Note

    • User preferences exist in the ~/.theia/settings.json file. Don’t change this file as Acquia can overwrite it with new features and values.
    • Workspace preferences exist in the ~/project/.theia/settings.json file after you perform a change. This file has precedence over User preferences and includes custom settings.

    Usually, Cloud IDE immediately uses your updated preferences. However, for certain preferences, you might need to reload the full page.

Tracking Cloud IDE preferences under version control

By design, Cloud IDEs are disposable. As such, you might want to delete an IDE or have multiple IDEs in parallel, and carry forward your preferences without having to configure new IDEs from scratch.

When the ~/project/.theia/settings.json file is available, it’s easy to add it to version control and track changes as part of your Cloud Platform application.

To track your Workspace settings.json file, complete the following steps:

  1. Verify that the .theia directory is currently not tracked under version control.

    ide:~/project (master) $ git status
    On branch master
    Untracked files:
      (use "git add <file>..." to include in what will be committed)
            .theia/
    
    nothing added to commit but untracked files present (use "git add" to track)
    
  1. Add the .theia directory to your Git repository and verify that the changes are ready to be committed.

    ide:~/project (master) $ git add .theia/ && git status
    On branch master
    Changes to be committed:
      (use "git restore --staged <file>..." to unstage)
            new file:   .theia/settings.json
    
  2. Commit your changes.

    ide:~/project (master +) $ git commit -m "Add Cloud IDE settings"
    [master 6ff6acb] Add Cloud IDE settings
     1 file changed, 4 insertions(+)
     create mode 100644 .theia/settings.json
    
  3. Push your changes to Git.

    ide:~/project (master +) $ $ git push
    Enumerating objects: 4, done.
    Counting objects: 100% (4/4), done.
    Delta compression using up to 16 threads
    Compressing objects: 100% (3/3), done.
    Writing objects: 100% (3/3), 1.74 KiB | 1.74 MiB/s, done.
    Total 3 (delta 1), reused 0 (delta 0)
    remote: Resolving deltas: 100% (1/1), completed with 1 local object.
    To github.com:user/repository.git
       c015078..312fbea  master -> master