Skip to content
Arc XP

Arc XP CLI: Themes Package

Managing site settings

The Arc XP CLI Themes Package offers a set of tools to manage and manipulate blocks.json settings. These utilities allow developers and site managers to view, export, and convert configuration properties across environments in a structured and reproducible format.

The arcxp themes site-properties group of subcommands is used to interact with Themes Settings, such as viewing current site configurations, exporting them to local files, and converting between different file formats.

Subcommands

arcxp themes site-properties print

Outputs the current site properties (including global and site-specific settings) directly to the terminal.

Usage:

Terminal window
arcxp themes site-properties print

Example Output:

{
  "global": {
    "property1": "value1",
    "property2": "value2"
  },
  "site": {
    "site-id-1": {
      "propertyA": "valueA"
    },
    "site-id-2": {
      "propertyB": "valueB"
    }
  }
}

arcxp themes site-properties write-local-settings-file

Exports site properties from the current Arc XP environment and saves them as a .json file on your local machine. This is useful for version control, auditing, or making bulk edits offline.

Usage:

Terminal window
arcxp themes site-properties write-local-settings-file [options]

Options:

  • -o, --outputPath <outputPath> Specify a full path and filename for the output JSON file. If not provided, the file will default to a name like:

    blocks-YYYY-MM-DD-HHmmss.json

Example:

Terminal window
arcxp themes site-properties write-local-settings-file -o ./site-settings.json

arcxp themes site-properties convert-properties

Converts between .json and .xlsx formats for site properties. This is particularly useful for non-developers who prefer working in spreadsheet tools, or for bulk edits across multiple sites.

  • When converting to .xlsx:

    • Global settings are stored in a dedicated sheet.
    • Each site gets its own individual sheet for properties.

  • When converting to .json:

    • An .xlsx file is parsed and merged into a valid JSON structure.

Usage:

Terminal window
arcxp themes site-properties convert-properties

Note: This command operates in interactive mode only. You will be prompted to choose the source file and target format during execution.

Example Workflow:

  1. Export a .json with write-local-settings-file.
  2. Run convert-properties to transform the .json into a human-readable .xlsx.
  3. Edit in Excel.
  4. Convert the .xlsx back to .json.
  5. Push changes using Arc XP tools or through the CMS.

Best Practices

  • Use print to quickly audit current configurations.
  • Use write-local-settings-file before making changes, as a backup and for version tracking.
  • Use convert-properties when collaborating with stakeholders who prefer spreadsheets.

Conclusion

The arcxp themes site-properties command set empowers teams to manage site settings in a transparent and structured way. Whether you’re auditing live settings, making controlled edits, or transforming data formats, these commands offer flexibility and control tailored to real-world workflows in Arc XP.