hasura.ts

const stringArg: Fig.Arg = {
  name: "string",
};

const sharedOptions: Fig.Option[] = [
  {
    name: "--envfile",
    description: ".env filename to load ENV vars from",
    args: {
      name: "string",
      template: "filepaths",
    },
  },
  {
    name: ["-h", "--help"],
    description: "Help for hasura",
  },
  {
    name: "--log-level",
    description: "Log level",
    args: {
      name: "string",
      suggestions: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"],
      default: "INFO",
    },
  },
  {
    name: "--no-color",
    description: "Do not colorize output",
  },
  {
    name: "--project",
    description: "Directory where commands are executed",
    args: {
      name: "string",
      template: "folders",
    },
  },
  {
    name: "--skip-update-check",
    description: "Skip automatic update check on command execution",
  },
];

const adminSecretOption: Fig.Option = {
  name: "--admin-secret",
  description: "Admin secret for Hasura GraphQL engine",
  args: stringArg,
};

const certificateAuthorityOption: Fig.Option = {
  name: "--certificate-authority",
  description: "Path to a cert file for the certificate authority",
  args: {
    name: "string",
    template: "filepaths",
  },
};

const endpointOption: Fig.Option = {
  name: "--endpoint",
  description:
    "Http(s) endpoint for Hasura GraphQL engine (env `HASURA_GRAPHQL_ENDPOINT`)",
  args: stringArg,
};

const insecureSkipTLSVerifyOption: Fig.Option = {
  name: "--insecure-skip-tls-verify",
  description: "Skip TLS verification and disable cert checking",
};
const actionsSharedOptions: Fig.Option[] = [
  adminSecretOption,
  certificateAuthorityOption,
  endpointOption,
  insecureSkipTLSVerifyOption,
];

const completionSpec: Fig.Spec = {
  name: "hasura",
  description: "Hasura GraphQL engine command line tool",
  subcommands: [
    {
      name: "actions",
      description: "Manage Hasura actions",
      subcommands: [
        {
          name: "codegen",
          description: "Generate code for actions",
          options: [
            {
              name: "--derive-from",
              description: "Derive action from a hasura operation",
              args: stringArg,
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
          args: {
            name: "action name",
            isOptional: true,
            isVariadic: true,
          },
        },
        {
          name: "create",
          description: "Create a Hasura action",
          options: [
            {
              name: "--derive-from",
              description: "Derive action from a Hasura operation",
              args: stringArg,
            },
            {
              name: "--kind",
              description: "Kind to use in action",
              args: {
                name: "string",
                isOptional: true,
                suggestions: ["synchronous", "asynchronous"],
              },
            },
            {
              name: "--webhook",
              description: "Webhook to use in action",
              args: {
                name: "webhook",
                isOptional: true,
              },
            },
            {
              name: "--with-codegen",
              description: "Create action along with codegen",
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
          args: {
            name: "action name",
            isOptional: true,
          },
        },
        {
          name: "use-codegen",
          description: "Use the codegen to generate code for Hasura actions",
          options: [
            {
              name: "--framework",
              description: "Framework to be used by codegen",
              args: stringArg,
            },
            {
              name: "--output-dir",
              description: "Directory to create the codegen files",
              args: {
                name: "string",
                template: "folders",
              },
            },
            {
              name: "--with-starter-kit",
              description: "Clone starter kit for a framework",
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
      ],
      options: [...actionsSharedOptions, ...sharedOptions],
    },
    {
      name: "completions",
      description: "Generate auto completion code",
      options: [
        {
          name: "--file",
          description: "File to which output has to be written",
          args: {
            name: "string",
            template: "filepaths",
          },
        },
        ...sharedOptions,
      ],
      args: {
        name: "shell",
        isOptional: true,
        suggestions: ["bash", "zsh"],
      },
    },
    {
      name: "console",
      description: "Open the console to manage the database and try out APIs",
      options: [
        {
          name: "--address",
          description: "Address to serve console and migration API from",
          args: {
            name: "string",
            default: "localhost",
            isOptional: true,
          },
        },
        {
          name: "--api-port",
          description: "Port for serving migrate api",
          args: {
            name: "string",
            isOptional: true,
            default: "9693",
          },
        },
        {
          name: "--browser",
          description: "Open console in a specific browser",
          args: stringArg,
        },
        {
          name: "--console-port",
          description: "Port for serving console",
          args: {
            name: "string",
            default: "9695",
            isOptional: true,
          },
        },
        {
          name: "--insecure-skip-tls-verify",
          description: "Skip TLS verification and disable cert checking",
        },
        {
          name: "--no-browser",
          description: "Do not automatically open console in browser",
        },
        {
          name: "--static-dir",
          description:
            "Directory where static assets mentioned in the console html template can be served from",
          args: {
            name: "string",
            template: "folders",
          },
        },
        {
          name: "--use-server-assets",
          description:
            "When rendering console, use assets provided by HGE server",
        },
        ...actionsSharedOptions,
        ...sharedOptions,
      ],
    },
    {
      name: "init",
      description:
        "Initialize a directory for Hasura GraphQL engine migrations",
      options: [
        adminSecretOption,
        endpointOption,
        {
          name: "--install-manifest",
          description: "Install manifest to be cloned",
          args: stringArg,
        },
        {
          name: "--version",
          description: "Config version to be used",
          args: {
            name: "int",
            default: "3",
          },
        },
      ],
      args: {
        name: "directory name",
        isOptional: true,
      },
    },
    {
      name: ["md", "metadata"],
      subcommands: [
        {
          name: "apply",
          description: "Apply Hasura metadata on a database",
          options: [
            {
              name: "--dry-run",
              description:
                "Show metadata generated from project directory without applying to server",
            },
            {
              name: ["-o", "--output"],
              description: "Specify an output format to show applied metadata",
              args: {
                name: "string",
                isOptional: true,
                suggestions: ["json", "yaml"],
                default: "json",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "clear",
          description: "Clear Hasura GraphQL engine metadata on the database",
          options: [...actionsSharedOptions, ...sharedOptions],
        },
        {
          name: "diff",
          description: "Show a highlighted diff of Hasura metadata",
          options: [...actionsSharedOptions, ...sharedOptions],
          args: [
            {
              name: "file1",
              isOptional: true,
              template: "filepaths",
            },
            {
              name: "file2",
              isOptional: true,
              template: "filepaths",
            },
          ],
        },
        {
          name: "export",
          description:
            "Export Hasura GraphQL engine metadata from the database",
          options: [
            {
              name: ["-o", "--output"],
              description: "Specify an output format for exported metadata",
              args: stringArg,
            },
          ],
        },
        {
          name: ["ic", "inconsistency", "inconsistencies"],
          description: "Manage inconsistent objects in Hasura metadata",
          subcommands: [
            {
              name: "drop",
              description: "Drop inconsistent objects from the metadata",
              options: [...actionsSharedOptions, ...sharedOptions],
            },
            {
              name: ["ls", "list"],
              description: "List all inconsistent objects from the metadata",
              options: [...actionsSharedOptions, ...sharedOptions],
            },
            {
              name: "status",
              description: "Check if the metadata is inconsistent or not",
              options: [...actionsSharedOptions, ...sharedOptions],
            },
          ],
          options: [...actionsSharedOptions, ...sharedOptions],
        },
        {
          name: "reload",
          description: "Reload Hasura GraphQL engine metadata on the database",
          options: [...actionsSharedOptions, ...sharedOptions],
        },
      ],
      options: [...actionsSharedOptions, ...sharedOptions],
    },
    {
      name: "migrate",
      description: "Manage migrations on the database",
      subcommands: [
        {
          name: "apply",
          description: "Apply migrations on the database",
          options: [
            {
              name: "--up",
              description: "Apply all or N up migration steps",
              args: {
                name: "string",
                isOptional: true,
              },
            },
            {
              name: "--down",
              description: "Apply all or N up migration steps",
              args: {
                name: "string",
                isOptional: true,
              },
            },
            {
              name: "goto",
              description:
                "Apply migration chain up to to the version specified",
              args: stringArg,
            },
            {
              name: "--version",
              description: "Only apply this particular migration",
              args: stringArg,
            },
            {
              name: "--skip-execution",
              description:
                "Skip executing the migration action, but mark them as applied",
            },
            {
              name: "--type",
              description: "Type of migration to be used with version flag",
              args: {
                name: "string",
                suggestions: ["up", "down"],
                default: "up",
              },
            },
            {
              name: "--dry-run",
              description:
                "Print the names of migrations which are going to be applied",
            },
            {
              name: "--all-databases",
              description:
                "Set this flag to attempt to apply migrations on all databases present on server",
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "create",
          description: "Create files required for a migration",
          options: [
            {
              name: "--down-sql",
              description:
                "Sql string/query that is to be used to create a down migration",
              args: stringArg,
            },
            {
              name: "--from-server",
              description:
                "Take pg_dump of schema and Hasura metadata from the server",
            },
            {
              name: "--metadata-from-file",
              description:
                "Path to a hasura metadata file to be used for up actions",
              args: {
                name: "string",
                template: "filepaths",
              },
            },
            {
              name: "--metadata-from-server",
              description:
                "Take metadata from the server and write it as an up migration file",
            },
            {
              name: "--schema",
              description: "Name of Postgres schema to export as a migration",
              args: {
                name: "strings",
                isVariadic: true,
              },
            },
            {
              name: "--sql-from-file",
              description:
                "Path to an SQL file which contains the SQL statements",
              args: {
                name: "string",
                template: "filepaths",
              },
            },
            {
              name: "--sql-from-server",
              description:
                "Take pg_dump from the server and save it as a migration",
            },
            {
              name: "--up-sql",
              description:
                "Sql string/query that is to be used to create an up migration",
              args: stringArg,
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
          args: {
            name: "migration name",
            isOptional: true,
          },
        },
        {
          name: "delete",
          description: "Clear migrations from local project and server",
          options: [
            {
              name: "--all",
              description: "Clears all migrations for selected database",
            },
            {
              name: "--force",
              description: "Executes operation without any confirmation",
              isDangerous: true,
            },
            {
              name: "--version",
              description: "Deletes the specified version in migrations",
              args: {
                name: "uint",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "squash",
          description: "Squash multiple migrations into a single one",
          options: [
            {
              name: "--delete-source",
              description:
                "Delete the source files after squashing without any confirmation",
            },
            {
              name: "--from",
              description: "Start squashing from this version",
              args: {
                name: "uint",
              },
            },
            {
              name: "--name",
              description: "Name for the new squashed migration",
              args: {
                name: "string",
                default: "squashed",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "status",
          description: "Display current status of migrations on a database",
          ...actionsSharedOptions,
          ...sharedOptions,
        },
      ],
      options: [...actionsSharedOptions, ...sharedOptions],
    },
    {
      name: ["plugin", "plugins"],
      description: "Manage plugins for the CLI",
      subcommands: [
        {
          name: "install",
          description: "Install a plugin from the index",
          options: [
            {
              name: "--version",
              description: "Version to be installed",
              args: stringArg,
            },
            ...sharedOptions,
          ],
          args: {
            name: "plugin name",
            isOptional: true,
          },
        },
        {
          name: "list",
          description:
            "List all available plugins from index, versions and installation status",
          options: [
            {
              name: "--dont-update-index",
              description:
                "Do not update the plugin index local cache, only show the list",
            },
            ...sharedOptions,
          ],
        },
        {
          name: "uninstall",
          description: "Uninstall a plugin",
          options: sharedOptions,
          args: {
            name: "plugin name",
            isOptional: true,
          },
        },
        {
          name: "upgrade",
          description: "Upgrade a plugin to a newer version",
          options: [
            {
              name: "--version",
              description: "Version to be upgraded",
              args: stringArg,
            },
            ...sharedOptions,
          ],
          args: {
            name: "plugin name",
            isOptional: true,
          },
        },
      ],
      options: sharedOptions,
    },
    {
      name: "scripts",
      description: "Execute helper scripts to manage Hasura projects",
      subcommands: [
        {
          name: "update-project-v2",
          description: "Update the Hasura project from config v1 to v2",
          options: [
            {
              name: "--metadata-dir",
              description: "Metadata directory",
              args: {
                name: "string",
                template: "folders",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "update-project-v3",
          description: "Update the Hasura project from config v2 to v3",
          options: [
            {
              name: "--database-name",
              description:
                "Database name for which the current migrations / seeds belong to",
              args: stringArg,
            },
            {
              name: "--force",
              description: "Do not ask for confirmation",
              isDangerous: true,
            },
            {
              name: "--move-state-only",
              description: "Do only a state migration from old hdb_catalog",
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
      ],
      options: sharedOptions,
    },
    {
      name: ["sd", "seed", "seeds"],
      description: "Manage seed data",
      subcommands: [
        {
          name: "apply",
          description: "Apply seed data",
          options: [
            {
              name: ["-f", "--file"],
              description: "Seed file to apply",
              args: {
                name: "string array",
                template: "filepaths",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
        },
        {
          name: "create",
          description: "Create a new seed file",
          options: [
            {
              name: "--from-table",
              description:
                "Name of table from which seed file has to be initialized",
              args: {
                name: "string array",
              },
            },
            ...actionsSharedOptions,
            ...sharedOptions,
          ],
          args: {
            name: "seed name",
          },
        },
      ],
      options: [
        {
          name: "--database-name",
          description:
            "Database name for which the current migrations / seeds belong to",
          args: stringArg,
        },
        ...actionsSharedOptions,
        ...sharedOptions,
      ],
    },
    {
      name: "update-cli",
      description: "Update the CLI to latest or a specific version",
      options: [
        {
          name: "--version",
          description: "A specific version to install",
          args: {
            name: "string",
            isOptional: true,
          },
        },
        ...sharedOptions,
      ],
    },
    {
      name: "version",
      description: "Print the CLI version",
      options: sharedOptions,
    },
  ],
  options: sharedOptions,
};

export default completionSpec;