synopkg
Version:
Consistent dependency versions in large JavaScript Monorepos
88 lines (61 loc) • 2.47 kB
text/mdx
---
title: list
---
import { Badge } from "@astrojs/starlight/components";
import ConfigOption from "@partials/option/config.mdx";
import DependenciesOption from "@partials/option/dependencies.mdx";
import DependencyTypesOption from "@partials/option/dependency-types.mdx";
import HelpOption from "@partials/option/help.mdx";
import LogLevelsOption from "@partials/option/log-levels.mdx";
import NoAnsiOption from "@partials/option/no-ansi.mdx";
import QuoteFilters from "@partials/tips/quote-filters.mdx";
import ShowOption from "@partials/option/show-list.mdx";
import SortOption from "@partials/option/sort.mdx";
import SourceOption from "@partials/option/source.mdx";
import SpecifierTypesOption from "@partials/option/specifier-types.mdx";
Query and inspect all dependencies in your project, both valid and invalid.
## Examples
```bash
# Sort dependencies by how many times they are used
synopkg list --sort count
# Show every instance of each dependency, not just their names
synopkg list --show instances
# Show dependencies ignored in your synopkg config
synopkg list --show ignored
# Show highest level of detail
synopkg list --show all
# Choose only some values
synopkg list --show hints,statuses
# List all "peerDependencies"
synopkg list --dependency-types peer
# List all types packages
synopkg list --dependencies '@types/**'
# List instances of an exact version being used as a peer dependency
synopkg list --specifier-types exact --show instances --dependency-types peer
# See more examples
synopkg list --help
# See a short summary of options
synopkg list -h
```
## Options
<QuoteFilters />
### --config <Badge text="<file-path>" />
<ConfigOption command="list" />
### --dependencies <Badge text="<dependency-name-pattern>" />
<DependenciesOption command="list" />
### --dependency-types <Badge text="<comma-separated-dependency-type-names>" />
<DependencyTypesOption command="list" />
### --log-levels <Badge text="<comma-separated-log-level-names>" />
<LogLevelsOption command="list" />
### --no-ansi
<NoAnsiOption command="list" />
### --show <Badge text="<comma-separated-detail-names>" />
<ShowOption command="list" />
### --sort <Badge text="<choice>" />
<SortOption command="list" />
### --source <Badge text="<file-pattern>" />
<SourceOption command="list" />
### --specifier-types <Badge text="<comma-separated-specifier-type-names>" />
<SpecifierTypesOption command="list" />
### --help
<HelpOption command="list" />