Skip to content

Commit 43788e8

Browse files
authored
docs: --save option for the poly info, deps and libs commands (#21)
* docs: --save option for the poly info, deps and libs commands * docs: configurable command output paths
1 parent 0023f11 commit 43788e8

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/commands.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,8 @@ poly info
255255
### Options
256256
`--short` Display a view that is better adjusted to Workspaces with many projects.
257257

258+
`--save` Store the contents of this command to file.
259+
258260
## Diff
259261
Shows what has changed since the most recent stable point in time.
260262

@@ -367,6 +369,7 @@ The poly libs command will likely report the "cv2" as a missing dependency.
367369

368370
Using `--alias opencv-python=cv2` will make the command treat the alias as a third-party import.
369371

372+
`--save` Store the contents of this command to file.
370373

371374
## Check
372375
Validates the Polylith workspace, checking for any missing dependencies (bricks and third-party libraries):
@@ -514,6 +517,8 @@ Show brick depencencies for a specific project.
514517
`--brick`
515518
A detailed view for a single brick and the dependent bricks: used by, and uses.
516519

520+
`--save` Store the contents of this command to file.
521+
517522
## Test
518523
Polylith doesn't have its own test runner. Use your favorite testing tool, such as `pytest`.
519524

docs/configuration.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,23 @@ When `brick_docs_enabeld = true`, a README is added when creating a component or
5252

5353
### Testing
5454
The create component and brick [commands](commands.md) will also create corresponding unit tests when `enabled = true` in the test section of the workspace configuration.
55+
56+
57+
### Custom command output path
58+
The `poly info`, `poly deps` and `poly libs` commands have support for a `--save` option.
59+
By default, the command output will be saved to `development/poly/<the command>.txt`.
60+
But you can configure it, if you want to store the output in a different location.
61+
62+
Example configuration:
63+
64+
``` toml
65+
[tool.polylith.commands]
66+
output = "somewhere/else"
67+
```
68+
69+
Or, configure output location by command:
70+
71+
``` toml
72+
[tool.polylith.commands.deps]
73+
output = "somewhere/else"
74+
```

0 commit comments

Comments
 (0)