Skip to content

Arc XP CLI: IFX Package

The Arc XP CLI is your command center for automating workflows to accelerate development and simplify engineering workflows. Execute all IFX processes directly from the command line using the @arcxp/cli npm package.

Setup

  1. On your local machine, install the package globally npm i -g @arcxp/cli
  2. Create a directory with a settings file to store your env variables mkdir ~/.arcxp-cli && vim ~/.arcxp-cli/settings. You can swap environments by changing which variables are commented out:
    Terminal window
    # sandbox
    CONTENT_BASE=https://api.sandbox.{org}.arcpublishing.com/
    ARC_ACCESS_TOKEN=1234567890
    # prod
    # CONTENT_BASE=https://api.{org}.arcpublishing.com/
    # ARC_ACCESS_TOKEN=abcdefg
  3. Run arcxp to confirm the package is running as expected. You should see a prompt for selecting a product. Choose ifx and follow the prompts to manage your integrations.

From here, you can run the CLI globally.

Usage Modes

The CLI offers both script and interactive modes.

Interactive Mode

Interactive mode will guide you through each command and prompt you with questions to input. Run this mode by entering arcxp, select ifx from the list, and then following the prompts.

Script Mode

Use script mode by running arcxp ifx [command] [options]. This can be useful for automating tasks such as upload/deploy/promote a bundle.



Help us improve our documentation! Let us know if you do not find what you are looking for by posting suggestions to Our Ideas Portal.