Skip to content

docs: adjust docs (#72) #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
buarki merged 3 commits into from
Apr 13, 2026
Merged

docs: adjust docs (#72) #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16d7df7
docs: adjust docs (#72)
buarki Apr 13, 2026
65cd5b2
docs: adjust docs (#72)
buarki Apr 13, 2026
fe3df55
docs: adjust docs (#72)
buarki Apr 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
![Image](./docs/demo.gif)
SVG visualization:

![Image](./docs/demo.png)
![Image](./docs/BadLayout.svg)

## CLI installation

Expand Down Expand Up @@ -59,22 +59,22 @@ sudo mv viztruct /usr/local/bin/
### Analyze structs from a path

```sh
viztruct --path ./internal/samples/dumb_service.go --format=txt
viztruct --path ./internal/samples --format=txt
```

### Get JSON output
```sh
viztruct --path ./internal/samples/dumb_service.go --format=json
viztruct --path ./internal/samples --format=json
```

### Generate SVG visualization
```sh
viztruct --path ./internal/samples/dumb_service.go --format=json --svg
viztruct --path ./internal/samples --format=json --svg
```

### Analyze and define the optimization strategy
```sh
viztruct --path ./internal/samples/dumb_service.go --format=txt --strategies=alignment,size,group,greedy
viztruct --path ./internal/samples --format=txt --strategies=alignment,size,group,greedy
```

### Show help
Expand Down
Loading
Loading