Deploy a component to an instance

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read

    • Deploy your component to display in your instance as an application plugin.

    Before you begin

    Procedure

    Deploy the component to your instance.
    1. Open your system's command-line tool and execute this command. 
      $ snc ui-component deploy [--open --force]

      Pass in values for these arguments.

      Name Description
      open When true, opens the default browser and navigates to UI Builder in your instance.

      Default: false
      force Deploys component changes and overwrites any existing component records.

      Default: false.

      		 
      $ snc ui-component deploy --open

    What to do next

    Navigate to your instance and add your component to a modal or a landing page in Agent Workspace, or to Virtual Agent. For Agent Workspace, see rendering a Now component in a modal or creating custom landing pages for workspaces. For Virtual Agent, see Virtual Agent custom controls.