The Arc XP CLI is your command center for automating workflows to accelerate development and simplify engineering workflows.
For instructions on getting the CLI running on your local machine, visit this page: https://dev.arcxp.com/arcxp-cli/
- Node.js v20 or later is required to run this project.
--enable-debug-logs
Enable logging for environment loading
-V, --version
output the version number
Interact directly with the IFX APIs using the command line. Follow the guide to get started: https://dev.arcxp.com/integrations/ifx-cli/
arcxp ifx integrationsarcxp ifx secretsarcxp ifx custom-eventsarcxp ifx webhooksarcxp ifx logsarcxp ifx bundlesarcxp ifx event-subscriptions
arcxp ifx integrations listarcxp ifx integrations viewarcxp ifx integrations createarcxp ifx integrations updatearcxp ifx integrations delete
View a detailed list of all integrations.
arcxp ifx integrations list [options]-p, --page <page>
Page number, used with pageSize for paginating the list
-s, --pageSize <pageSize>
Number of items per page
View an integration's details and status.
arcxp ifx integrations view [options]-n, --name <name>
Name of integration to view
Create a new integration.
arcxp ifx integrations create [options]-n, --name <name>
Name of new integration
-d, --description <description>
Give it a description
-e, --email <email>
Email for receiving alerts
Update an existing integration.
arcxp ifx integrations update [options]-n, --name <name>
Name of integration to update
-d, --description [description]
Updated description (optional)
-e, --email [email]
Email for receiving alerts (optional)
-s --enabled <enabled>
Enable (true) or disable (false) the integration
Deletes an existing integration and all associated resources (except your Github repo).
arcxp ifx integrations delete [options]-n, --name <name>
Name of integration to delete (cannot be undone)
Lists secret names for an integration.
arcxp ifx secrets list [options]-n, --integrationName <integrationName>
Name of integration to list secrets
Add a new secret to an integration.
arcxp ifx secrets create [options]-n, --integrationName <integrationName>
Name of integration where the secret will be used
-s, --secretName <secretName>
Secret name to be referenced in your code
-v, --secretValue <secretValue>
The value of the secret
Update an existing secret.
arcxp ifx secrets update [options]-n, --integrationName <integrationName>
Name of integration
-s, --secretName <secretName>
Name of secret to be updated
-v, --secretValue <secretValue>
The new value of the secret
arcxp ifx custom-events listarcxp ifx custom-events registerarcxp ifx custom-events updatearcxp ifx custom-events delete-eventarcxp ifx custom-events delete-event-schedule
View your organization's existing custom events.
arcxp ifx custom-events list [options]-p, --page <page>
Page number, used with pageSize for paginating the list
-s, --pageSize <pageSize>
Number of items per page
Register a custom event for your organization to be used on a schedule or with a webhook.
arcxp ifx custom-events register [options]-e, --eventName <eventName>
Name the event e.g. custom:schedule_report
-d, --description <description>
Describe what the event will be used for
-s, --schedule [schedule]
6-field cron string e.g. 0 12 ? * WED * (optional)
Update description and/or schedule of an existing custom event.
arcxp ifx custom-events update [options]-e, --eventName <eventName>
The custom event name to be updated
-d, --description [description]
Updated description (optional)
-s, --schedule [schedule]
6-field cron string e.g. 0 12 ? * WED * (optional)
Delete a custom event. The event must not have any active subscriptions. Note this action cannot be undone, but you can recreate the event if needed.
arcxp ifx custom-events delete-event [options]-e, --eventName <eventName>
Name of event to delete (cannot be undone)
Delete an event's schedule without deleting the event itself. This action cannot be undone, but the schedule can be added back to the event.
arcxp ifx custom-events delete-event-schedule [options]-e, --eventName <eventName>
Name of event whose schedule to delete
arcxp ifx webhooks listarcxp ifx webhooks registerarcxp ifx webhooks updatearcxp ifx webhooks deletearcxp ifx webhooks trigger
View your organization's existing webhooks.
arcxp ifx webhooks list [options]-p, --page <page>
Page number, used with pageSize for paginating the list
-s, --pageSize <pageSize>
Number of items per page
Once you have created a custom event, register a webhook to receive the request for that event.
arcxp ifx webhooks register [options]-e, --eventName <eventName>
Name of event you want linked to your webhook
-d, --description <description>
Describe what the webhook will do
Update the description for a webhook.
arcxp ifx webhooks update [options]-e, --eventName <eventName>
Name of event you want linked to your webhook
-d, --description <description>
Updated description (optional)
Remove a webhook for an event. Note this action cannot be undone! If you need to recreate this webhook, a new UUID will be issued.
arcxp ifx webhooks delete [options]-e, --eventName <eventName>
Name of event associated with the webhook
Triggers a webhook by its UUID.
arcxp ifx webhooks trigger [options]-u, --uuid <uuid>
The UUID of the webhook to trigger
-p, --payload <payload>
JSON-formatted custom payload
View log search results.
arcxp ifx logs search [options]-n, --name <name>
Integration name to search
-q, --query [search query]
Optional keywords to search for in logs
-s, --startDateTime [YYYY-MM-DD HH:MM:SS]
START timestamp in format YYYY-MM-DD [HH:MM:SS], default 300s ago
-e, --endDateTime [YYYY-MM-DD HH:MM:SS]
END timestamp in format YYYY-MM-DD [HH:MM:SS], default 'now'
arcxp ifx bundles listarcxp ifx bundles uploadarcxp ifx bundles deployarcxp ifx bundles promotearcxp ifx bundles download
Get a list of all uploaded bundles for an integration.
arcxp ifx bundles list [options]-n, --name <name>
Integration name to list bundles
Upload a zipped bundle for an integration.
arcxp ifx bundles upload [options]-n, --integrationName <integrationName>
Integration name for bundle upload
-b, --bundleName <bundleName>
Provide a unique bundle name
-p, --bundlePath <bundlePath>
Local path to the zipped bundle
Deploy an uploaded bundle so that it can be promoted to live.
arcxp ifx bundles deploy [options]-n, --name <name>
Name of integration
-b, --bundleName <bundleName>
Name of bundle to deploy
Promote a specific bundle version to live. Any traffic after the promotion will go to the newly promoted bundle.
arcxp ifx bundles promote [options]-n, --name <name>
Name of integration
-v, --versionNumber <versionNumber>
Bundle version to promote to live
Promote a specific bundle version to live. Any traffic after the promotion will go to the newly promoted bundle.
arcxp ifx bundles download [options]-n, --name <name>
Name of integration
-b --bundleName <bundleName>
Name of bundle to download
-o --outputFilePath <outputFilePath>
Local file path including filename to save the zip e.g. /Users/me/zips/somename.zip
arcxp ifx event-subscriptions listarcxp ifx event-subscriptions createarcxp ifx event-subscriptions update
List all event subscriptions.
arcxp ifx event-subscriptions list [options]Subscribe to an event so that your integration will be invoked when the event is received.
arcxp ifx event-subscriptions create [options]-n, --name <name>
Name of integration that will be triggered for this event
-e, --eventName <eventName>
Name of event you are subscribing to
-s, --enabled [enabled]
Enable (true) or disable (false) the subscription
Manage an existing event subscription
arcxp ifx event-subscriptions update [options]-n, --name <name>
Integration name associated with the event
-e, --eventName <eventName>
Event name to update
-s, --enabled <enabled>
Enable (true) or disable (false) the subscription
Interact with PageBuilder tools
View logs associated with a specific request ID
arcxp pagebuilder view-logs [options]-r, --requestId <requestId>
Arc PageBuilder request ID to search logs for
Scripts for managing site settings
arcxp themes site-properties printarcxp themes site-properties write-local-settings-filearcxp themes site-properties convert-properties
Output current settings in terminal
arcxp themes site-properties printOutput a file with the site properties stored in Themes Settings
arcxp themes site-properties write-local-settings-file [options]-o, --outputPath <outputPath>
Full path and file name to save .json. Defaults to blocks-${year}-${month}-${day}-${hours}${minutes}${seconds}.json
Converts a .json file to .xlsx, or .xlsx to .json When saving to .xlsx, global settings will be saved to 1 sheet and each site's properties will be in their own sheets.
* Interactive mode only