Function NewCmdReadDir

pkg/cmd/repo/read-dir/read_dir.go:44–99

NewCmdReadDir creates the `gh repo read-dir` command.

(f *cmdutil.Factory, runF func(*ReadDirOptions) error)

// NewCmdReadDir creates the `gh repo read-dir` command.
func NewCmdReadDir(f *cmdutil.Factory, runF func(*ReadDirOptions) error) *cobra.Command {
	opts := &ReadDirOptions{
		IO:         f.IOStreams,
		HttpClient: f.HttpClient,
		BaseRepo:   f.BaseRepo,
	}

	cmd := &cobra.Command{
		Use:   "read-dir [<path>] [flags]",
		Short: "List a directory in a repository (preview)",
		Long: heredoc.Docf(`
			List the contents of a directory in a GitHub repository without cloning it.

			This command is in preview and subject to change without notice.

			By default, the directory is listed from the default branch. Use the %[1]s--ref%[1]s flag to
			list from a specific branch, tag, or commit. When no path is given, the repository root
			is listed.
		`, "`"),
		Example: heredoc.Doc(`
			# List the root of the default branch
			$ gh repo read-dir --repo cli/cli

			# List a subdirectory
			$ gh repo read-dir docs --repo cli/cli

			# List a directory at a specific ref
			$ gh repo read-dir docs --repo cli/cli --ref v2.50.0

			# Print selected fields as JSON
			$ gh repo read-dir docs --repo cli/cli --json name,path,type,size
		`),
		Args: cobra.MaximumNArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			opts.BaseRepo = f.BaseRepo

			if len(args) > 0 {
				opts.Path = args[0]
			}

			if runF != nil {
				return runF(opts)
			}

			return readDirRun(opts)
		},
	}

	cmd.Flags().StringVar(&opts.Ref, "ref", "", "The branch, tag, or commit to list from")

	cmdutil.AddJSONFlags(cmd, &opts.Exporter, dirEntryFields)

	cmdutil.EnableRepoOverride(cmd, f)

	return cmd
}

func readDirRun(opts *ReadDirOptions) error {