Back to Moon

query tasks

website/docs/commands/query/tasks.mdx

2.2.41.9 KB
Original Source

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

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

shell
# Find all tasks grouped by project
$ moon query tasks

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

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

ts
{
	tasks: Record<string, Record<string, Task>>,
	options: QueryOptions,
}

Arguments

Options

Affected

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

Filters<VersionLabel version="1.30.0" />

All option values are case-insensitive regex patterns.

  • --command <regex> - Filter tasks that match this command.
  • --id <regex> - Filter tasks that match this ID.
  • --project <regex> - Filter tasks that belong to this project.
  • --script <regex> - Filter tasks that match this script.
  • --toolchain <regex> - Filter tasks of this toolchain. <VersionLabel version="1.31.0" />
  • --type <regex> - Filter tasks of this type.

Configuration