Skip to main content

wf export

wf export

Exports the configuration of a workspace, the platform, or all objects to disk


Exports the current configuration of a workspace, the platform, or the whole state of Wayfinder to disk.

The scope controls what is output:

  • 'platform': outputs platform-wide non-workspaced resources only (such as cluster plans, global DNS zones, etc)
  • 'workspace': outputs workspace-scoped resources (such as clusters, apps, etc) from the current workspace only. Must be combined with -w or --workspace.
  • 'all': outputs both platform-wide and workspace-scoped resources in all workspaces
wf export [flags]


# Exports a workspace:
$ wf export --scope workspace -w wsp -p ./output

# Dump a workspace cloud configuration:
$ wf export --scope workspace -w wsp -p ./output --kind CloudAccessConfig

# Dump platform config:
$ wf export --scope platform -p ./output

# Dump everything:
$ wf export --scope all -p ./output


  -h, --help                  help for export
--keep-wf-annotations Use to retain any Wayfinder-managed (i.e.*) annotations when exporting
--keep-wf-labels Use to retain any Wayfinder-managed (i.e.*) labels when exporting
--kind strings Limit the export to the specified kind(s) - can be specified multiple times if required
-p, --path PATH path to output files to PATH
--scope string Valid values are 'platform' (outputs all non-workspaced objects) 'workspace' (outpus all objects for the current workspace) or 'all' (outputs all platform and workspace objects)
--with-read-only Includes any read-only resources (i.e. those managed by Wayfinder directly) when exporting
--with-secrets Includes any secrets when exporting
--with-system Includes any system resources (i.e. those delivered by and required for Wayfinder system functionality) when exporting

Options inherited from parent commands

      --debug              Indicates we should use debug / trace logging (default: false)
--force Used to force an operation to happen (default: false)
--no-wait Indicates we should not wait for resources to provision
-o, --output string Output format of the resource (json,yaml,table,template) (default "table")
--profile string Use a profile other than your default for this command
--show-headers Indicates we should display headers on table out (default true)
--verbose Enables verbose logging for debugging purposes (default: false)
-w, --workspace string The workspace you are operating within


  • wf - wf provides a cli for Wayfinder