Skip to main content

Minefield CLI

Query​

Custom queries allow users to perform complex searches by combining multiple commands. These queries can be used to analyze the relationships between different nodes in the graph.

When running a custom query, there are multiple commands that can be used. For example, the custom command:

minefield query "dependencies library pkg:generic/dep1@1.0.0 and dependencies library pkg:generic/lib-A@1.0.0"

This custom command uses the commands "dependencies" and "and".

Available Commands​

dependencies​

  • Description: Retrieves all dependencies of a specified node.
  • Usage: dependencies <node_type> <node_name>
  • Example: dependencies library pkg:generic/dep1@1.0.0

dependents​

  • Description: Retrieves all dependents of a specified node.
  • Usage: dependents <node_type> <node_name>
  • Example: dependents library pkg:generic/dep1@1.0.0

and​

  • Description: Combines two queries with a logical AND, returning nodes that satisfy both conditions.
  • Usage: <query1> and <query2>
  • Example: dependencies library pkg:generic/dep1@1.0.0 and dependencies library pkg:generic/lib-A@1.0.0

or​

  • Description: Combines two queries with a logical OR, returning nodes that satisfy either condition.
  • Usage: <query1> or <query2>
  • Example: dependencies library pkg:generic/dep1@1.0.0 or dependencies library pkg:generic/lib-A@1.0.0

xor​

  • Description: Combines two queries with a logical XOR, returning nodes that satisfy one condition but not both.
  • Usage: <query1> xor <query2>
  • Example: dependencies library pkg:generic/dep1@1.0.0 xor dependencies library pkg:generic/lib-A@1.0.0

Examples​

To find the dependencies shared by dep1 and lib-A, you can use the following custom query:

minefield query "dependencies library pkg:generic/dep1@1.0.0 and dependencies library pkg:generic/lib-A@1.0.0"

This query will return all nodes that are dependencies of both dep1 and lib-A.

Flags​

--visualize : This flag will visualize the query, by creating a graph of the nodes and edges.

--addr : This flag will specify the port that the visualization will be hosted on.

--outputdir: This flag will specify the directory that the query will be saved to, the query will be saved as a files in the directory, with the name of each file being the name of the node in that query, the the file wil contain the metadata of the node.

--max-output: This flag will specify the maximum number of nodes that the query will return.

Leaderboard​

The leaderboard command is used to generate a leaderboard of nodes based on a specified query, sorted by the number of nodes returned by the query.

Custom Leaderboard​

To create a custom leaderboard, you can use the leaderboard custom command.

Usage​

minefield leaderboard custom <query>

Examples​

To create a leaderboard of based on there dependents, you can use the following command:

minefield leaderboard custom "dependents library"

This will generate a leaderboard of nodes based on the number of dependents they have.

We can also sort by the number of circular dependencies a node has.

minefield leaderboard custom "dependents library and depedencies library"

if a node has dependents that are also dependencies, they will pop up on this query, and we will be sorting by the length of the output of the query.

As you can see, this command differs from the 'query' command's script, since we do not a node. This is because we are running this query on every single node, and then sorting them by the length of the output of the query.

This command can only be run after running the cache .

Flags​

--max-output: This flag will specify the maximum number of nodes that the query will return.

--concurrency: This flag will specify the number of concurrent queries that the leaderboard will run, this is useful for speeding up the query.

--all: shows the queries for each node, instead of the size of the output.

allKeys​

The allKeys command is used to generate a list of all the keys in the graph. This does not need the cache command to be run first, since allKeys does not sort by any value, it just returns all the keys in the graph.

Usage​

minefield leaderboard allKeys

Flags​

--max-output: This flag will specify the maximum number of nodes that the query will return.

Cache​

Usage​

minefield cache

Flags​

--clear : This flag will clear the cache, removing all cached, but leaving the graph unchanged.

Ingest​

SBOM​

Usage​

minefield ingest sbom <sbom_file or directory>