query projects

import VersionLabel from '@site/src/components/Docs/VersionLabel';

Use the moon query projects sub-command to query information about all projects in the project graph. The project list can be filtered by passing a query statement as an argument, or by using options arguments.

# Find all projects
$ moon query projects

# Find all projects with an id that matches "react"
$ moon query projects --id react
$ moon query projects "project~react"

# Find all projects with a `lint` or `build` task
$ moon query projects --tasks "lint|build"
$ moon query projects "task=[lint,build]"

This will output a list of projects as JSON. The output has the following structure:

{
	projects: Project[],
	options: QueryOptions,
}

Affected projects

This command can also be used to query for affected projects, based on the state of the VCS working tree. For advanced control, you can also pass the results of moon query changed-files to stdin.

# Find all affected projects
$ moon query projects --affected

# Find all affected projects using the results of another query
$ moon query changed-files | moon query projects --affected

Arguments

• [query] - An optional query statement to filter projects with. When provided, all filter options are ignored. <VersionLabel version="1.4.0" />

Options

Affected

• --affected - Filter projects that have been affected by changed files.
• --downstream - Include downstream dependents of queried projects. Supports "none" (default), "direct", "deep". <VersionLabel version="1.29.0" />
• --upstream - Include upstream dependencies of queried projects. Supports "none" (default), "direct", "deep". <VersionLabel version="1.29.0" />

Filters

All option values are case-insensitive regex patterns.

• --alias <regex> - Filter projects that match this alias.
• --id <regex> - Filter projects that match this ID/name.
• --language <regex> - Filter projects of this programming language.
• --layer <regex> - Filter project of this layer.
• --source <regex> - Filter projects that match this source path.
• --stack <regex> - Filter projects of the tech stack.
• --tags <regex> - Filter projects that have the following tags.
• --tasks <regex> - Filter projects that have the following tasks.

Configuration

• projects in .moon/workspace.*