Skip to content

github CLI gist create command uses the term "private" but gist documentation uses the term "secret" #3872

@jfl209

Description

@jfl209

Describe the bug

The github CLI (version 1.11.0) displays the following info for creating gists:

$ gh gist create --help
Create a new GitHub gist with given contents.

Gists can be created from one or multiple files. Alternatively, pass "-" as
file name to read from standard input.

By default, gists are private; use '--public' to make publicly listed ones.


USAGE
  gh gist create [<filename>... | -] [flags]

FLAGS
  -d, --desc string       A description for this gist
  -f, --filename string   Provide a filename to be used when reading from STDIN
  -p, --public            List the gist publicly (default: private)

However, github gist documentation says:

Every gist is a Git repository, which means that it can be forked and cloned. If you are signed in to GitHub when you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your gist home page.

Gists can be public or secret. Public gists show up in Discover, where people can browse new gists as they're created. They're also searchable, so you can use them if you'd like other people to find and see your work.

Secret gists don't show up in Discover and are not searchable. Secret gists aren't private. 

I think at the very least the command line interface should use the same semantics as the web.

Steps to reproduce the behavior

  1. gh gist create --help
  2. See output describing private gists.

Expected vs actual behavior

Expected:

CLI refers to gists as either public or secret

Actual:

CLI refers to gists as either public or private.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingpriority-3Affects a small number of users or is largely cosmetic

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions