List stages in the project.
targetsfor more details.
Prints a list of stages including their names and a one-line description (which
can be omitted using
--name-only). This command is useful for discovering or
reviewing what stages are present in the project without having to examine
dvc.yaml files manually.
dvc stage list lists the stages from
the current working directory) by default.
The stage description is read from the
desc field in
dvc.yaml (truncated to
80 characters) if it exists. Otherwise, DVC generates one with the stage's most
important characteristics (dependencies, outputs, or metrics).
targets(optional command argument) - location of the stages to list (
./dvc.yamlby default). Examples:
dvc stage list linear/dvc.yaml: A
dvc stage list -R pipelines/: Directory to explore recursively for stages
dvc stage list train-model: Specific stage(s) from
dvc stage list modeling/dvc.yaml:prepare: Stage(s) from a specific
dvc stage list train-model@1: Foreach stage(s) from
--name-only- only lists stage names. Useful for scripting purposes (DVC uses it for shell tab completion).
--recursive- determines the files to list by searching each target directory and its subdirectories for
dvc.yamlfiles to inspect. If there are no directories among the
targets, this option has no effect.
--all- lists all stages from all
dvc.yamlfiles in the repo (regardless of any given
--fail- fails immediately if any target
dvc.yamlfile is invalid. By default, those errors are skipped. Only has an effect with
--help- prints the usage/help message, and exit.
--quiet- do not write anything to standard output. Exit with 0 if no problems arise, otherwise 1.
--verbose- displays detailed tracing information.
The default behavior is to list stages from
$ dvc stage list prepare Outputs data/prepared featurize Outputs data/features train Outputs model.pkl evaluate Reports scores.json, prc.json, roc.json
In this case, all of the descriptions were generated by DVC.