pull

The pull command allows you to pull one or more workspaces from a Structurizr server.

Options

  • -id: The workspace ID (required: integer workspace ID or * for all workspaces)
  • -key: The workspace or admin API key (required if authentication is enabled on the server)
  • -url: The Structurizr API URL (required)
  • -branch: Branch name (optional)
  • -passphrase: The passphrase to use (optional; only required if client-side encryption enabled on the workspace)
  • -output: Relative or absolute path to an output directory (optional)

Example

To pull the content of a single Structurizr workspace:

pull -url https://structurizr.example.com/api -id 1234 -key 1234567890

To pull the content of all workspaces (this requires the admin API key):

pull -url https://structurizr.example.com -id * -key 1234567890