Skip to content

Commit

Permalink
Adds merge command.
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Brown committed Mar 2, 2024
1 parent 63b85e0 commit 6d7cf5c
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 3 deletions.
1 change: 1 addition & 0 deletions cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The Structurizr CLI is a command line utility designed to be used in conjunction
- [lock](/cli/lock) a workspace
- [unlock](/cli/unlock) a workspace
- [export](/cli/export) diagrams to PlantUML, Mermaid, WebSequenceDiagrams, DOT, and Ilograph; or a DSL workspace to JSON
- [merge](/cli/merge) layout information from one workspace into another
- [list](/cli/list) elements within a workspace
- [validate](/cli/validate) a JSON/DSL workspace
- [inspect](/cli/inspect) a JSON/DSL workspace
Expand Down
2 changes: 1 addition & 1 deletion cli/inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: inspect
parent: Structurizr CLI
nav_order: 8
nav_order: 9
permalink: /cli/inspect
---

Expand Down
2 changes: 1 addition & 1 deletion cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: list
parent: Structurizr CLI
nav_order: 6
nav_order: 7
permalink: /cli/list
---

Expand Down
26 changes: 26 additions & 0 deletions cli/merge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: default
title: merge
parent: Structurizr CLI
nav_order: 6
permalink: /cli/merge
---

# merge

The `merge` command allows you to merge the layout information from one workspace into another.

## Options

- -workspace: The path or URL to the workspace JSON/DSL file (required)
- -layout: The path or URL to the workspace JSON file that includes layout information (required)
- -view: The key of the view to merge layout information for (optional; default is all views in workspace)
- -output: Path and name of an output file (required)

## Examples

To merge the layout from one JSON workspace into another:

```
./structurizr.sh merge -workspace workspace-without-layout.json -layout workspace-with-layout.json -output workspace.json
```
2 changes: 1 addition & 1 deletion cli/validate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: validate
parent: Structurizr CLI
nav_order: 7
nav_order: 8
permalink: /cli/validate
---

Expand Down

0 comments on commit 6d7cf5c

Please sign in to comment.