package list import ( "fmt" "time" "github.com/MakeNowJust/heredoc/v2" "github.com/spf13/cobra" gitlab "gitlab.com/gitlab-org/api/client-go/v3" "gitlab.com/gitlab-org/cli/internal/cmdutils" "gitlab.com/gitlab-org/cli/internal/commands/ci/ciutils" "gitlab.com/gitlab-org/cli/internal/mcpannotations" "gitlab.com/gitlab-org/cli/internal/utils" ) func NewCmdList(f cmdutils.Factory) *cobra.Command { pipelineListCmd := &cobra.Command{ Use: "list [flags]", Short: `List CI/CD pipelines.`, Long: heredoc.Docf(` Defaults to the current project. Use %[1]s--status%[1]s to filter pipelines by status. `, "`"), Example: heredoc.Doc(` glab ci list glab ci list --status=failed`), Args: cobra.NoArgs, ValidArgsFunction: cobra.NoFileCompletions, Annotations: map[string]string{ mcpannotations.Safe: "true", }, RunE: func(cmd *cobra.Command, args []string) error { var err error var titleQualifier string client, err := f.GitLabClient() if err != nil { return err } repo, err := f.BaseRepo() if err != nil { return err } l := &gitlab.ListProjectPipelinesOptions{ ListOptions: gitlab.ListOptions{ Page: 1, }, } format, _ := cmd.Flags().GetString("output") jsonOut := format == "json" if m, _ := cmd.Flags().GetString("status"); m != "" { l.Status = new(gitlab.BuildStateValue(m)) titleQualifier = m } // Support both --order and --orderBy (deprecated) for backward compatibility var orderByValue string if cmd.Flags().Changed("orderBy") { orderByValue, _ = cmd.Flags().GetString("orderBy") } else { orderByValue, _ = cmd.Flags().GetString("order") } if orderByValue != "" { l.OrderBy = new(orderByValue) } if m, _ := cmd.Flags().GetString("sort"); m != "" { l.Sort = new(m) } if p, _ := cmd.Flags().GetInt("page"); p != 0 { l.Page = int64(p) } if p, _ := cmd.Flags().GetInt("per-page"); p != 0 { l.PerPage = int64(p) } if m, _ := cmd.Flags().GetString("ref"); m != "" { l.Ref = new(m) } if m, _ := cmd.Flags().GetString("scope"); m != "" { l.Scope = new(m) } if m, _ := cmd.Flags().GetString("source"); m != "" { l.Source = new(m) } if m, _ := cmd.Flags().GetString("sha"); m != "" { l.SHA = new(m) } if m, _ := cmd.Flags().GetBool("yaml-errors"); m { l.YamlErrors = new(m) } if m, _ := cmd.Flags().GetString("name"); m != "" { l.Name = new(m) } if m, _ := cmd.Flags().GetString("username"); m != "" { l.Username = new(m) } if m, _ := cmd.Flags().GetString("updated-after"); m != "" { updatedAfterTime, err := time.Parse("2006-01-02T15:04:05Z", m) if err != nil { return err } l.UpdatedAfter = new(updatedAfterTime) } if m, _ := cmd.Flags().GetString("updated-before"); m != "" { updatedBeforeTime, err := time.Parse("2006-01-02T15:04:05Z", m) if err != nil { return err } l.UpdatedBefore = new(updatedBeforeTime) } pipes, resp, err := client.Pipelines.ListProjectPipelines(repo.FullName(), l) if err != nil { return err } title := utils.NewListTitle(fmt.Sprintf("%s pipeline", titleQualifier)) title.RepoName = repo.FullName() title.Page = int(l.Page) title.CurrentPageTotal = len(pipes) if resp != nil { title.Total = int(resp.TotalItems) } if jsonOut { return f.IO().PrintJSON(pipes) } else { f.IO().LogInfof("%s\n%s\n", title.Describe(), ciutils.DisplayMultiplePipelines(f.IO(), pipes, repo.FullName())) } return nil }, } pipelineListCmd.Flags().StringP("status", "s", "", "Filter pipelines by status. Options: running, pending, success, failed, canceled, skipped, created, manual, waiting_for_resource, preparing, scheduled.") pipelineListCmd.Flags().StringP("order", "o", "id", "Order pipelines by this field. Options: id, status, ref, updated_at, user_id.") pipelineListCmd.Flags().String("orderBy", "id", "Deprecated: use --order instead.") _ = pipelineListCmd.Flags().MarkDeprecated("orderBy", "use --order instead") pipelineListCmd.Flags().StringP("sort", "", "desc", "Sort direction for '--order': asc or desc.") pipelineListCmd.Flags().IntP("page", "p", 1, "Page number.") pipelineListCmd.Flags().IntP("per-page", "P", 0, "Number of items to list per page. Defaults to the GitLab API default (20).") pipelineListCmd.Flags().StringP("output", "F", "text", "Format output. Options: text, json.") pipelineListCmd.Flags().StringP("ref", "r", "", "Return only pipelines for the given ref.") pipelineListCmd.Flags().String("scope", "", "Return only pipelines with the given scope. Options: running, pending, finished, branches, tags.") pipelineListCmd.Flags().String("source", "", "Return only pipelines triggered by the given source. For the full list, see https://docs.gitlab.com/ci/jobs/job_rules/#ci_pipeline_source-predefined-variable. Commonly used options: merge_request_event, parent_pipeline, pipeline, push, trigger.") pipelineListCmd.Flags().String("sha", "", "Return only pipelines with the given SHA.") pipelineListCmd.Flags().BoolP("yaml-errors", "y", false, "Return only pipelines with invalid configurations.") pipelineListCmd.Flags().StringP("name", "n", "", "Return only pipelines with the given name.") pipelineListCmd.Flags().StringP("username", "u", "", "Return only pipelines triggered by the given username.") pipelineListCmd.Flags().StringP("updated-before", "b", "", "Return only pipelines updated before the specified date. Expected in ISO 8601 format (2019-03-15T08:00:00Z).") pipelineListCmd.Flags().StringP("updated-after", "a", "", "Return only pipelines updated after the specified date. Expected in ISO 8601 format (2019-03-15T08:00:00Z).") cmdutils.AddJQFlag(pipelineListCmd, f.IO()) return pipelineListCmd }