Skip to content

Latest commit

 

History

History
93 lines (70 loc) · 3.58 KB

organization-dependencies.md

File metadata and controls

93 lines (70 loc) · 3.58 KB

Organization dependency inventory

socket organization dependencies lists dependency records already known to the authenticated organization. It does not scan the current directory. The command does not accept a package name or an organization slug.

Access

Run socket login and approve the device code in your browser. The CLI saves the OAuth session. You can also set SOCKET_CLI_API_TOKEN to use an API token. The inventory available to the command depends on the credential you use. The command requires API access.

List dependencies

Run the command without options to request the first 50 dependency artifacts:

socket organization dependencies

Use --limit to set the number of dependency artifacts requested. The API accepts values from 1 to 100. The default is 50. Use --offset to skip that many dependency artifacts; the default is 0. For example, request results in batches of 20:

socket organization dependencies --limit 20 --offset 0
socket organization dependencies --limit 20 --offset 20
socket organization dependencies --limit 20 --offset 40

Check the output's “Is there more data after this?” value. Continue with the next offset until it says no. The limit applies to dependency artifacts. An artifact can have more than one repository link, so the displayed row count can be greater than the limit. Each invocation makes one request; the command does not paginate automatically.

Filter by package

Use --purls to find dependency artifacts by package URL (PURL). Supply one complete PURL per flag; repeat the flag to search for multiple packages:

socket organization dependencies --purls 'pkg:npm/minimist@0.0.4'
socket organization dependencies \
  --purls 'pkg:npm/minimist' \
  --purls 'pkg:pypi/requests@2.32.3' \
  --json

A PURL can include an exact version or omit the version to match all indexed versions of that package. Package type, namespace, and name are matched as provided; for example, pkg:npm/%40types/node keeps the scoped npm namespace. Searches do not support substring, wildcard, or version-range matching. Qualifiers and subpaths are rejected because this search endpoint filters only package identity and version. If the server does not confirm every requested PURL, the CLI reports a failure and does not display dependency rows.

Each request searches one page, so combine --purls with --limit and --offset to continue through matching artifacts. The rows include the organization repositories and branches currently linked to those artifacts.

Choose an output format

The default output and --markdown display a text table with ecosystem, namespace, name, version, repository, branch, and direct dependency columns. The output also shows the requested offset and limit and whether more data is available.

Use --json to write the result envelope to a file:

socket organization dependencies --json > dependencies.json

On success, the JSON envelope contains ok and data. Read dependency rows from data.rows; data also includes end, limit, and offset. When you search with --purls, it also includes the server's filter confirmation in data.purlFilters. The --json and --markdown options cannot be used together.

Help and dry run

Use --help to see the available options:

socket organization dependencies --help

A dry run does not retrieve inventory. It only reports what the command would request. On the 2.x prerelease, dry run requires authentication and reports the selected limit, offset, and PURL filters. On 1.x, it exits before making a request and prints a generic dry-run message.