nighthawk 0.2.0

{
  "name": "sanity",
  "description": "Sanity CLI tool for managing Sanity installations, managing plugins, schemas and datasets",
  "subcommands": [
    {
      "name": "help",
      "description": "Displays help information about Sanity",
      "args": [
        {
          "name": "command"
        }
      ]
    },
    {
      "name": "build",
      "description": "Builds the current Sanity configuration to a static bundle",
      "options": [
        {
          "names": [
            "--source-maps"
          ],
          "description": "Enable source maps for built bundles (increases size of bundle)"
        },
        {
          "names": [
            "--no-minify"
          ],
          "description": "Skip minifying built JavaScript (speeds up build, increases size of bundle)"
        },
        {
          "names": [
            "-y",
            "--yes"
          ],
          "description": "Use unattended mode, accepting defaults and using only flags for choices"
        }
      ]
    },
    {
      "name": "codemod",
      "description": "Runs a code modification script",
      "options": [
        {
          "names": [
            "--dry"
          ],
          "description": "Dry run (no changes are made to files)"
        },
        {
          "names": [
            "--extensions"
          ],
          "description": "Transform files with these file extensions (comma separated list) (default: js,ts,tsx)",
          "takes_arg": true,
          "arg": {
            "name": "extensions"
          }
        },
        {
          "names": [
            "--no-verify"
          ],
          "description": "Skip verification before running codemod"
        }
      ]
    },
    {
      "name": "configcheck",
      "description": "Checks if the required configuration files for plugins exists and are up to date"
    },
    {
      "name": "cors",
      "description": "Interact with CORS-entries for your project",
      "subcommands": [
        {
          "name": "add",
          "description": "Allow a new origin to use your project API through CORS",
          "options": [
            {
              "names": [
                "--credentials"
              ],
              "description": "Allow credentials (token/cookie) to be sent from this origin"
            },
            {
              "names": [
                "--no-credentials"
              ],
              "description": "Disallow credentials (token/cookie) to be sent from this origin"
            }
          ],
          "args": [
            {
              "name": "origin",
              "description": "The origin to allow"
            }
          ]
        },
        {
          "name": "delete",
          "description": "Delete an existing CORS-origin from your project",
          "args": [
            {
              "name": "origin",
              "description": "The origin to delete"
            }
          ]
        },
        {
          "name": "list",
          "description": "List all origins allowed to access the API for this project"
        }
      ]
    },
    {
      "name": "dataset",
      "description": "Interact with datasets in your project",
      "subcommands": [
        {
          "name": "alias",
          "description": "You can manage your dataset alias using this command",
          "subcommands": [
            {
              "name": "create",
              "args": [
                {
                  "name": "alias-name"
                },
                {
                  "name": "target-dataset"
                }
              ]
            },
            {
              "name": "delete",
              "args": [
                {
                  "name": "alias-name"
                }
              ]
            },
            {
              "name": "link",
              "options": [
                {
                  "names": [
                    "--force"
                  ],
                  "description": "Skips security prompt and forces link command"
                }
              ],
              "args": [
                {
                  "name": "alias-name"
                },
                {
                  "name": "target-dataset"
                }
              ]
            },
            {
              "name": "unlink",
              "args": [
                {
                  "name": "alias-name"
                }
              ]
            }
          ]
        },
        {
          "name": "copy",
          "description": "Manages dataset copying, including starting a new copy job, listing copy jobs and following the progress of a running copy job",
          "options": [
            {
              "names": [
                "--detach"
              ],
              "description": "Start the copy without waiting for it to finish"
            },
            {
              "names": [
                "--attach"
              ],
              "description": "Attach to the running copy process to show progress",
              "takes_arg": true,
              "arg": {
                "name": "job-id"
              }
            },
            {
              "names": [
                "--skip-history"
              ],
              "description": "Don't preserve document history on copy"
            },
            {
              "names": [
                "--list"
              ],
              "description": "Lists all dataset copy jobs corresponding to a certain criteria"
            },
            {
              "names": [
                "--offset"
              ],
              "description": "Start position in the list of jobs. Default 0. With --list",
              "takes_arg": true,
              "arg": {
                "name": "offset"
              }
            },
            {
              "names": [
                "--limit"
              ],
              "description": "Maximum number of jobs returned. Default 10. Maximum 1000. With --list",
              "takes_arg": true,
              "arg": {
                "name": "limit"
              }
            }
          ],
          "args": [
            {
              "name": "source-dataset"
            },
            {
              "name": "target-dataset"
            }
          ]
        },
        {
          "name": "create",
          "description": "Create a new dataset within your project",
          "options": [
            {
              "names": [
                "--visibility"
              ],
              "description": "Set visibility for this dataset (public/private)",
              "takes_arg": true,
              "arg": {
                "name": "visibility",
                "suggestions": [
                  "public",
                  "private"
                ]
              }
            }
          ],
          "args": [
            {
              "name": "name"
            }
          ]
        },
        {
          "name": "delete",
          "description": "Delete a dataset within your project",
          "args": [
            {
              "name": "datasetName"
            }
          ]
        },
        {
          "name": "export",
          "description": "Export dataset to local filesystem as a gzipped tarball",
          "options": [
            {
              "names": [
                "--raw"
              ],
              "description": "Extract only documents, without rewriting asset references"
            },
            {
              "names": [
                "--no-assets"
              ],
              "description": "Export only non-asset documents and remove references to image assets"
            },
            {
              "names": [
                "--no-drafts"
              ],
              "description": "Export only published versions of documents"
            },
            {
              "names": [
                "--no-compress"
              ],
              "description": "Skips compressing tarball entries (still generates a gzip file)"
            },
            {
              "names": [
                "--types"
              ],
              "description": "Defines which document types to export",
              "takes_arg": true,
              "arg": {
                "name": "types"
              }
            },
            {
              "names": [
                "--overwrite"
              ],
              "description": "Overwrite any file with the same name"
            },
            {
              "names": [
                "--asset-concurrency"
              ],
              "description": "Concurrent number of asset downloads",
              "takes_arg": true,
              "arg": {
                "name": "num"
              }
            }
          ],
          "args": [
            {
              "name": "name"
            },
            {
              "name": "destination",
              "template": "folders"
            }
          ]
        },
        {
          "name": "import",
          "description": "Import documents to given dataset from ndjson file",
          "options": [
            {
              "names": [
                "--missing"
              ],
              "description": "On duplicate document IDs, skip importing document in question"
            },
            {
              "names": [
                "--replace"
              ],
              "description": "On duplicate document IDs, replace existing document with imported document"
            },
            {
              "names": [
                "--allow-failing-assets"
              ],
              "description": "Skip assets that cannot be fetched/uploaded"
            },
            {
              "names": [
                "--replace-assets"
              ],
              "description": "Skip reuse of existing assets"
            }
          ],
          "args": [
            {
              "name": "file",
              "template": "filepaths"
            },
            {
              "name": "target_dataset"
            }
          ]
        },
        {
          "name": "list",
          "description": "List datasets of your project"
        },
        {
          "name": "visibility",
          "description": "Set visibility of a dataset",
          "args": [
            {
              "name": "dataset"
            },
            {
              "name": "mode",
              "suggestions": [
                "get",
                "set"
              ]
            }
          ]
        }
      ]
    },
    {
      "name": "debug",
      "description": "Gathers information on Sanity environment",
      "options": [
        {
          "names": [
            "--secrets"
          ],
          "description": "Include API keys in output"
        }
      ]
    },
    {
      "name": "deploy",
      "description": "Deploys a statically built Sanity studio",
      "options": [
        {
          "names": [
            "--source-maps"
          ],
          "description": "Enable source maps for built bundles (increases size of bundle)"
        },
        {
          "names": [
            "--no-minify"
          ],
          "description": "Skip minifying built JavaScript (speeds up build, increases size of bundle)"
        },
        {
          "names": [
            "--no-build"
          ],
          "description": "Don't build the studio prior to deploy, instead deploying the version currently in `dist/`"
        }
      ],
      "args": [
        {
          "name": "source_dir",
          "template": "folders"
        }
      ]
    },
    {
      "name": "docs",
      "description": "Opens the Sanity documentation"
    },
    {
      "name": "documents",
      "description": "Interact with documents in your project",
      "subcommands": [
        {
          "name": "create",
          "description": "Create one or more documents",
          "options": [
            {
              "names": [
                "--replace"
              ],
              "description": "On duplicate document IDs, replace existing document with specified document(s)"
            },
            {
              "names": [
                "--missing"
              ],
              "description": "On duplicate document IDs, don't modify the target document(s)"
            },
            {
              "names": [
                "--watch"
              ],
              "description": "Write the documents whenever the target file or buffer changes"
            },
            {
              "names": [
                "--json5"
              ],
              "description": "Use JSON5 file type to allow a \"simplified\" version of JSON"
            },
            {
              "names": [
                "--id"
              ],
              "description": "Specify a document ID to use. Will fetch remote document ID and populate editor",
              "takes_arg": true,
              "arg": {
                "name": "id"
              }
            },
            {
              "names": [
                "--dataset"
              ],
              "description": "NAME to override dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            }
          ],
          "args": [
            {
              "name": "file",
              "template": "filepaths"
            }
          ]
        },
        {
          "name": "delete",
          "description": "Delete a document by ID",
          "options": [
            {
              "names": [
                "--dataset"
              ],
              "description": "NAME to override dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            }
          ],
          "args": [
            {
              "name": "id",
              "is_variadic": true
            }
          ]
        },
        {
          "name": "get",
          "description": "Get and print a document by ID",
          "options": [
            {
              "names": [
                "--pretty"
              ],
              "description": "Colorized JSON output"
            },
            {
              "names": [
                "--dataset"
              ],
              "description": "NAME to override dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            }
          ],
          "args": [
            {
              "name": "document_id"
            }
          ]
        },
        {
          "name": "query",
          "description": "Query for documents",
          "options": [
            {
              "names": [
                "--pretty"
              ],
              "description": "Colorized JSON output"
            },
            {
              "names": [
                "--dataset"
              ],
              "description": "NAME to override dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            },
            {
              "names": [
                "--api-version"
              ],
              "description": "API version to use (defaults to `v1`)",
              "takes_arg": true,
              "arg": {
                "name": "version"
              }
            }
          ],
          "args": [
            {
              "name": "query"
            }
          ]
        }
      ]
    },
    {
      "name": "exec",
      "description": "Runs a script in Sanity context",
      "options": [
        {
          "names": [
            "--with-user-token"
          ],
          "description": "Preload access token from CLI config into 'part:@sanity/base/client' part"
        },
        {
          "names": [
            "--mock-browser-env"
          ],
          "description": "Mocks a browser-like environment using jsdom"
        }
      ],
      "args": [
        {
          "name": "script",
          "template": "filepaths"
        }
      ]
    },
    {
      "name": "graphql",
      "description": "Interact with GraphQL APIs",
      "subcommands": [
        {
          "name": "deploy",
          "description": "Deploy a GraphQL API from the current Sanity schema",
          "options": [
            {
              "names": [
                "--dataset"
              ],
              "description": "Deploy API for the given dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            },
            {
              "names": [
                "--tag"
              ],
              "description": "Deploy API to given tag (defaults to 'default')",
              "takes_arg": true,
              "arg": {
                "name": "tag"
              }
            },
            {
              "names": [
                "--generation"
              ],
              "description": "API generation to deploy (defaults to 'gen3')",
              "takes_arg": true,
              "arg": {
                "name": "generation"
              }
            },
            {
              "names": [
                "--non-null-document-fields"
              ],
              "description": "Set document interface fields (_id, _type etc) as non-null"
            },
            {
              "names": [
                "--playground"
              ],
              "description": "Deploy a GraphQL playground for easily testing queries (public)"
            },
            {
              "names": [
                "--no-playground"
              ],
              "description": "Skip playground prompt (do not deploy a playground)"
            },
            {
              "names": [
                "--force"
              ],
              "description": "Deploy API without confirming breaking changes"
            }
          ]
        },
        {
          "name": "list",
          "description": "Lists all the GraphQL endpoints deployed for this project"
        },
        {
          "name": "undeploy",
          "description": "Remove a deployed GraphQL API",
          "options": [
            {
              "names": [
                "--dataset"
              ],
              "description": "Delete GraphQL API for the given dataset",
              "takes_arg": true,
              "arg": {
                "name": "dataset"
              }
            },
            {
              "names": [
                "--tag"
              ],
              "description": "Delete GraphQL API for the given tag (defaults to 'default')",
              "takes_arg": true,
              "arg": {
                "name": "tag"
              }
            }
          ]
        }
      ]
    },
    {
      "name": "hook",
      "description": "Interact with hooks in your project",
      "subcommands": [
        {
          "name": "attempt",
          "description": "Print details of a given webhook delivery attempt",
          "args": [
            {
              "name": "attempt_id"
            }
          ]
        },
        {
          "name": "create",
          "description": "Create a new hook for the given dataset"
        },
        {
          "name": "delete",
          "description": "Delete a hook within your project",
          "args": [
            {
              "name": "name"
            }
          ]
        },
        {
          "name": "list",
          "description": "List hooks for a given project"
        },
        {
          "name": "logs",
          "description": "List latest log entries for a given hook",
          "args": [
            {
              "name": "name"
            }
          ]
        }
      ]
    },
    {
      "name": "init",
      "description": "Initialize a new Sanity project or plugin",
      "options": [
        {
          "names": [
            "-y",
            "--yes"
          ],
          "description": "Use unattended mode, accepting defaults and using only flags for choices"
        },
        {
          "names": [
            "--project"
          ],
          "description": "Project ID to use for the studio",
          "takes_arg": true,
          "arg": {
            "name": "projectId"
          }
        },
        {
          "names": [
            "--organization"
          ],
          "description": "Organization ID to use for the project",
          "takes_arg": true,
          "arg": {
            "name": "organizationId"
          }
        },
        {
          "names": [
            "--dataset"
          ],
          "description": "Dataset name for the studio",
          "takes_arg": true,
          "arg": {
            "name": "dataset"
          }
        },
        {
          "names": [
            "--dataset-default"
          ],
          "description": "Set up a project with a public dataset named \"production\""
        },
        {
          "names": [
            "--output-path"
          ],
          "description": "Path to write studio project to",
          "takes_arg": true,
          "arg": {
            "name": "path"
          }
        },
        {
          "names": [
            "--template"
          ],
          "description": "Project template to use [default: \"clean\"]",
          "takes_arg": true,
          "arg": {
            "name": "template"
          }
        },
        {
          "names": [
            "--provider"
          ],
          "description": "Login provider to use",
          "takes_arg": true,
          "arg": {
            "name": "provider"
          }
        },
        {
          "names": [
            "--visibility"
          ],
          "description": "Visibility mode for dataset (public/private)",
          "takes_arg": true,
          "arg": {
            "name": "mode",
            "suggestions": [
              "public",
              "private"
            ]
          }
        },
        {
          "names": [
            "--create-project"
          ],
          "description": "Create a new project with the given name",
          "takes_arg": true,
          "arg": {
            "name": "name"
          }
        },
        {
          "names": [
            "--project-plan"
          ],
          "description": "Optionally select a plan for a new project",
          "takes_arg": true,
          "arg": {
            "name": "name"
          }
        },
        {
          "names": [
            "--coupon"
          ],
          "description": "Optionally select a coupon for a new project (cannot be used with --project-plan)",
          "takes_arg": true,
          "arg": {
            "name": "name"
          }
        },
        {
          "names": [
            "--reconfigure"
          ],
          "description": "Reconfigure Sanity studio in current folder with new project/dataset"
        }
      ]
    },
    {
      "name": "install",
      "description": "Installs a Sanity plugin to the current Sanity configuration",
      "args": [
        {
          "name": "plugin"
        }
      ]
    },
    {
      "name": "login",
      "description": "Authenticates against the Sanity.io API (no flag) or a third-party identity provider (with --sso flag)",
      "options": [
        {
          "names": [
            "--sso"
          ],
          "description": "Authenticate against a third-party identity provider",
          "takes_arg": true,
          "arg": {
            "name": "slug"
          }
        }
      ]
    },
    {
      "name": "logout",
      "description": "Logs out of the Sanity.io session"
    },
    {
      "name": "manage",
      "description": "Opens the Sanity project management UI"
    },
    {
      "name": "projects",
      "description": "Interact with projects connected to your logged in user",
      "subcommands": [
        {
          "name": "list",
          "description": "Lists projects connected to your user",
          "options": [
            {
              "names": [
                "--sort"
              ],
              "description": "Sort output by specified column",
              "takes_arg": true,
              "arg": {
                "name": "field"
              }
            },
            {
              "names": [
                "--order"
              ],
              "description": "Sort output ascending/descending",
              "takes_arg": true,
              "arg": {
                "name": "order",
                "suggestions": [
                  "asc",
                  "desc"
                ]
              }
            }
          ]
        }
      ]
    },
    {
      "name": "start",
      "description": "Starts a web server for the Content Studio",
      "options": [
        {
          "names": [
            "--port"
          ],
          "description": "TCP port to start server on. [default: 3333]",
          "takes_arg": true,
          "arg": {
            "name": "port"
          }
        },
        {
          "names": [
            "--host"
          ],
          "description": "The local network interface at which to listen. [default: \"127.0.0.1\"]",
          "takes_arg": true,
          "arg": {
            "name": "host"
          }
        }
      ]
    },
    {
      "name": "undeploy",
      "description": "Removes the deployed studio from <hostname>.sanity.studio"
    },
    {
      "name": "uninstall",
      "description": "Removes a Sanity plugin from the current Sanity configuration",
      "args": [
        {
          "name": "plugin"
        }
      ]
    },
    {
      "name": "upgrade",
      "description": "Upgrades all (or some) Sanity modules to their latest versions",
      "options": [
        {
          "names": [
            "--range"
          ],
          "description": "Version range to upgrade to, eg '^2.2.7' or '2.1.x'",
          "takes_arg": true,
          "arg": {
            "name": "range"
          }
        },
        {
          "names": [
            "--tag"
          ],
          "description": "Tagged release to upgrade to, eg 'canary' or 'some-feature'",
          "takes_arg": true,
          "arg": {
            "name": "tag"
          }
        },
        {
          "names": [
            "--save-exact"
          ],
          "description": "Pin the resolved version numbers in package.json (no ^ prefix)"
        }
      ]
    },
    {
      "name": "users",
      "description": "Manage users of your project",
      "subcommands": [
        {
          "name": "invite",
          "description": "Invite a new user to the project",
          "options": [
            {
              "names": [
                "--role"
              ],
              "description": "Role to invite the user as",
              "takes_arg": true,
              "arg": {
                "name": "role"
              }
            }
          ],
          "args": [
            {
              "name": "email"
            }
          ]
        },
        {
          "name": "list",
          "description": "List users of the project",
          "options": [
            {
              "names": [
                "--no-invitations"
              ],
              "description": "Don't include pending invitations"
            },
            {
              "names": [
                "--no-robots"
              ],
              "description": "Don't include robots (token users)"
            },
            {
              "names": [
                "--sort"
              ],
              "description": "Sort users by specified column: id, name, role, date",
              "takes_arg": true,
              "arg": {
                "name": "field",
                "suggestions": [
                  "id",
                  "name",
                  "role",
                  "date"
                ]
              }
            },
            {
              "names": [
                "--order"
              ],
              "description": "Sort output ascending/descending",
              "takes_arg": true,
              "arg": {
                "name": "order",
                "suggestions": [
                  "asc",
                  "desc"
                ]
              }
            }
          ]
        }
      ]
    },
    {
      "name": "versions",
      "description": "Shows the installed versions of Sanity CLI and core components"
    }
  ],
  "options": [
    {
      "names": [
        "--help",
        "-h"
      ],
      "description": "Show help for sanity"
    }
  ]
}