Skip to content

Commit

Permalink
go: extend docs (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexTereshenkov authored Oct 7, 2024
1 parent f4304ba commit ef1cb74
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,32 @@ The tool serves as a faster way to query the dependency graph of a project. This

`dg-query` has a ton of functionality grouped under individual commands:

### `dependencies`
### `dependencies` (`deps`)
Identify dependencies of given node(s), optionally transitively (`--transitive`).

* identify dependencies of given node(s), optionally transitively
Options:
* specify depth when searching for dependencies transitively (`--depth`)
* include the build target itself in the output (`--reflexive`)

### `dependents` (`rdeps`)
Identify dependents of given node(s), optionally transitively (`--transitive`).

Options:
* specify depth when searching for dependents transitively (`--depth`)
* include the build target itself in the output (`--reflexive`)

### paths
Get paths between individual targets.

Options:
* `--from` and `--to` targets to find paths between
* `--n` limits the number of paths returned (helpful with a large graph)

### metrics

Get dependency graph related metrics. A dependency graph (`--dg`) may be used,
or a reverse dependency graph (`--rdg`) may be used, if you have one.

Metrics:
* dependency count (optionally, transitively)
* dependent count (optionally, transitively)

0 comments on commit ef1cb74

Please sign in to comment.