UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

Last updated May 7, 2026

uip rpa get-workflow-example

uip rpa get-workflow-example downloads the XAML content of a curated workflow example. The verb is the second half of a discover-then-fetch pair: uip rpa list-workflow-examples returns example keys (paths in the example catalog), and this verb resolves a key into the actual XAML you can save into a project.

Studio resolves the example index, so the verb requires a Windows runner.

Synopsis

uip rpa get-workflow-example --key <string>
uip rpa get-workflow-example --key <string>

Options

FlagDescription
--key <string>Blob key/path of the example workflow, as returned by list-workflow-examples. Example: email-automation/add-new-gmail-emails-to-keap-as-contacts.xaml.

For the complete option list on your installed tool version, run:

uip rpa get-workflow-example --help
uip rpa get-workflow-example --help

Examples

# Fetch a specific example XAML by key
uip rpa get-workflow-example \
  --key "email-automation/add-new-gmail-emails-to-keap-as-contacts.xaml"

# Pipe the result to a file in your project
uip rpa get-workflow-example \
  --key "web-api-automation/post-message-to-slack.xaml" \
  --output plain > Workflows/PostToSlack.xaml
# Fetch a specific example XAML by key
uip rpa get-workflow-example \
  --key "email-automation/add-new-gmail-emails-to-keap-as-contacts.xaml"

# Pipe the result to a file in your project
uip rpa get-workflow-example \
  --key "web-api-automation/post-message-to-slack.xaml" \
  --output plain > Workflows/PostToSlack.xaml

See also

  • Synopsis
  • Options
  • Examples
  • Related
  • See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated