gt.ts

const submitOptions: Fig.Option[] = [
  {
    name: "--always",
    description:
      "Always push updates, even if the branch has not changed. Can be helpful for fixing an inconsistent Graphite stack view on Web/GitHub resulting from downtime/a bug",
  },
  {
    name: "--branch",
    description:
      "Which branch to run this command from. Defaults to the current branch",
    args: {
      name: "branch",
      description: "Name of branch",
    },
  },
  {
    name: ["--confirm", "-c"],
    description:
      "Reports the PRs that would be submitted and asks for confirmation before pushing branches and opening/updating PRs. If either of --no-interactive or --dry-run is passed, this flag is ignored",
  },
  {
    name: ["--draft", "-d"],
    description:
      "If set, marks PR as draft. If --no-interactive is true, new PRs will be created in draft mode",
  },
  {
    name: "--dry-run",
    description:
      "Reports the PRs that would be submitted and terminates. No branches are pushed and no PRs are opened or updated",
  },
  {
    name: ["--edit", "-e"],
    description:
      "Input metadata for all PRs interactively. If neither --edit nor --no-edit is passed, only prompts for new PRs",
  },
  {
    name: ["--force", "-f"],
    description:
      "Force push: overwrites the remote branch with your local branch. Otherwise defaults to --force-with-lease",
  },
  {
    name: ["--merge-when-ready", "-m"],
    description:
      "If set, marks all PRs being submitted as merge when ready, which will let them automatically merge as soon as all merge requirements are met",
  },
  {
    name: ["--no-edit", "-n"],
    description: "Don't edit PR fields inline. Takes precedence over --edit",
  },
  {
    name: ["--publish", "-p"],
    description:
      "If set, publishes PR. If --no-interactive is true, new PRs will be created in draft mode",
  },
  {
    name: "--rerequest-review",
    description: "Rerequest review from current reviewers",
  },
  {
    name: "--restack",
    description:
      "Restack branches before submitting. If there are conflicts, output the branch names that could not be restacked",
  },
  {
    name: ["--reviewers", "-r"],
    description:
      "If set without an argument, prompt to manually set reviewers. Alternatively, accepts a comma separated string of reviewers",
    args: {
      name: "reviewers",
      description: "Comma separated string of reviewers",
      isOptional: true,
    },
  },
  {
    name: ["--stack", "-s"],
    description:
      "Submit descendants of the current branch in addition to its ancestors",
  },
  {
    name: ["--update-only", "-u"],
    description: "Only update the PRs that have been already been submitted",
  },
];

const completionSpec: Fig.Spec = {
  name: "gt",
  description: "Graphite.dev CLI",
  subcommands: [
    {
      name: "aliases",
      description: "Edit your command aliases",
      options: [
        {
          name: "--reset",
          description: "Reset your alias configuration",
        },
      ],
    },
    {
      name: "auth",
      description:
        "Add your auth token to enable Graphite CLI to create and update your PRs on GitHub",
      priority: 50,
      options: [
        {
          name: ["--token", "-t"],
          description:
            "Auth token. Get it from: https://app.graphite.dev/activate",
          args: {
            name: "token",
            description: "Auth token",
          },
        },
      ],
    },
    {
      name: ["bottom", "b"],
      description: "Switch to the first branch from trunk in the current stack",
    },
    {
      name: "changelog",
      description: "Show the Graphite CLI changelog",
      priority: 50,
    },
    {
      name: ["checkout", "co"],
      description:
        "Switch to a branch. If no branch is provided, opens an interactive selector",
      args: {
        name: "branch",
        description: "Name of branch to checkout",
        isOptional: true,
      },
      options: [
        {
          name: ["--show-untracked", "-u"],
          description: "Include untracked branched in interactive selection",
        },
      ],
    },
    {
      name: "children",
      description: "Show the children of the current branch",
    },
    {
      name: "completion",
      description: "Set up bash or zsh tab completion",
    },
    {
      name: "config",
      description: "Configure the Graphite CLI",
    },
    {
      name: ["continue", "cont"],
      description:
        "Continues the most recent Graphite command halted by a merge conflict",
      options: [
        {
          name: ["--all", "-a"],
          description: "Stage all changes before continuing",
        },
      ],
    },
    {
      name: ["create", "c"],
      description:
        "Create a new branch stacked on top of the current branch and commit staged changes. If no branch name is specified but a commit message is passed, generate a branch name from the commit message",
      args: {
        name: "name",
        description: "Branch name",
        isOptional: true,
      },
      options: [
        {
          name: ["--message", "-m"],
          description:
            "Commit staged changes on the new branch with this message",
          args: {
            name: "message",
            description: "Commit message",
          },
        },
        {
          name: ["--all", "-a"],
          description:
            "Stage all unstaged changes on the new branch with this message",
        },
        {
          name: ["--patch", "-p"],
          description: "Pick hunks to stage before committing",
        },
        {
          name: ["--insert", "-i"],
          description:
            "When true, any existing children of the current branch will become children of the new branch",
        },
      ],
    },
    {
      name: "dash",
      description: "Open the web dashboard",
    },
    {
      name: ["delete", "dl"],
      description: "Delete a branch and its corresponding Graphite metadata",
      args: {
        name: "name",
        description: "Branch name",
      },
      options: [
        {
          name: ["--force", "-f"],
          description: "Delete the branch even if it is not merged or closed",
        },
      ],
    },
    {
      name: "docs",
      description: "Show the Graphite CLI docs",
    },
    {
      name: ["down", "d"],
      description: "Switch to the parent of the current branch",
      args: {
        name: "steps",
        description: "The number of levels to traverse downstack",
        isOptional: true,
        default: "1",
      },
      options: [
        {
          name: ["--steps", "-n"],
          description: "The number of levels to traverse downstack",
          args: {
            name: "steps",
            default: "1",
          },
        },
      ],
    },
    {
      name: "feedback",
      description: "Commands for providing feedback and debug state",
      args: {
        name: "message",
        description:
          "Post a string directly to the maintainers' Slack so they can drown in praise, factor in your feedback, laugh at your jokes, cry at your insults, or fall victim to Slack injection attacks",
        isOptional: true,
      },
      options: [
        {
          name: "--print-debug-context",
          description:
            "Print a debug summary of your repository. Useful for creating bug report details",
        },
        {
          name: "--with-debug-context",
          description:
            "Include a blob of json describing your repo's state to help with debugging. Run 'gt feedback debug-context' to see what would be included",
        },
      ],
    },
    {
      name: "fish",
      description: "Set up 'fish' tab completion",
    },
    {
      name: ["fold", "f"],
      description:
        "Fold a branch's changes into its parent, update dependencies of descendants of the new combined branch, and restack",
      options: [
        {
          name: ["--keep", "-k"],
          description:
            "Keeps the name of the current branch instead of using the name of its parent",
        },
      ],
    },
    {
      name: "get",
      description:
        "Get branches from trunk to the specified branch from remote, prompting the user to resolve conflicts. If no branch is provided, get downstack from the current branch",
      args: {
        name: "branch",
        description: "Branch to get from remote",
        isOptional: true,
      },
      options: [
        {
          name: ["--force", "-f"],
          description:
            "Overwrite all fetched branches with remote source of truth",
        },
      ],
    },
    {
      name: ["info", "i"],
      description: "Display information about the current branch",
      options: [
        {
          name: ["--patch", "-p"],
          description: "Show the changes made by each commit",
        },
        {
          name: ["--diff", "-d"],
          description:
            "Show the diff between this branch and its parent. Takes precedence over patch",
        },
        {
          name: ["--body", "-b"],
          description: "Show the PR body, if it exists",
        },
        {
          name: ["--stat", "-s"],
          description:
            "Show a diffstat instead of a full diff. Modifies either --patch or --diff. If neither is passed, implies --diff",
        },
      ],
    },
    {
      name: "init",
      description:
        "Initialize Graphite in this repository by selecting a trunk branch. Can also be used to change the trunk branch of the repository",
      options: [
        {
          name: "--reset",
          description: "Untrack all branches",
        },
        {
          name: "--trunk",
          description:
            "The name of your trunk branch. If no name is passed, you will be prompted to select one interactively",
          args: {
            name: "trunk",
            description: "Name of the trunk branch",
            isOptional: true,
          },
        },
      ],
    },
    {
      name: ["log", "l"],
      description: "Commands that log your stacks",
      options: [
        {
          name: "--classic",
          description:
            "Use the old short logging style, which runs out of screen real estate more quickly. Other options will not work in classic mode",
        },
        {
          name: ["--reverse", "-r"],
          description:
            "Print the log upside down. Handy when you have a lot of branches",
        },
        {
          name: ["--show-untracked", "-u"],
          description: "Include untracked branched in interactive selection",
        },
        {
          name: ["--stack", "-s"],
          description:
            "Only show ancestors and descendants of the current branch",
        },
        {
          name: ["--steps", "-n"],
          description:
            "Only show this many levels upstack and downstack. Implies --stack",
          dependsOn: ["--stack"],
          args: {
            name: "Number of steps",
          },
        },
      ],
      subcommands: [
        {
          name: "",
          description:
            "Log all branches tracked by Graphite, showing dependencies and info for each",
        },
        {
          name: "long",
          description: "Display a graph of the commit ancestry of all branches",
        },
        {
          name: "short",
          description:
            "Log all stacks tracked by Graphite, arranged to show dependencies",
        },
      ],
    },
    {
      name: "merge",
      description:
        "Merge the pull requests associated with all branches from trunk to the current branch via Graphite",
      options: [
        {
          name: ["--confirm", "-c"],
          description:
            "Asks for confirmation before merging branches. Prompts for confirmation if the local branches differ from remote, regardless of the value of this flag",
        },
        {
          name: "--dry-run",
          description:
            "Reports the PRs that would be merged and terminates. No branches are merged",
        },
      ],
    },
    {
      name: ["modify", "m"],
      description:
        "Modify the current branch by amending its commit or creating a new commit. Automatically restacks descendants. If you have any unstaged changes, you will be asked whether you'd like to stage them",
      options: [
        {
          name: ["--all", "-a"],
          description: "Stage all changes before committing",
        },
        {
          name: ["--commit", "-c"],
          description:
            "Create a new commit instead of amending the current commit. If this branch has no commits, this command always creates a new commit",
        },
        {
          name: ["--edit", "-e"],
          description:
            "If passed, open an editor to edit the commit message. When creating a new commit, this flag is ignored",
        },
        {
          name: "--interactive-rebase",
          description:
            "Ignore all other flags and start a git interactive rebase on the commits in this branch",
        },
        {
          name: ["--message", "-m"],
          description:
            "The message for the new or amended commit. If passed, no editor is opened",
          args: {
            name: "message",
            description: "Commit message",
          },
        },
        {
          name: ["--patch", "-p"],
          description: "Pick hunks to stage before committing",
        },
      ],
    },
    {
      name: "move",
      description:
        "Rebase the current branch onto the target branch and restack all of its descendants. If no branch is passed in, opens an interactive selector",
      options: [
        {
          name: ["--onto", "-o"],
          description: "Branch to move the current branch onto",
          args: {
            name: "branch",
            description: "Branch to move",
          },
        },
        {
          name: "--source",
          description: "Branch to move (defaults to current branch)",
          args: {
            name: "branch",
            description: "Branch to move",
          },
        },
      ],
    },
    {
      name: "parent",
      description: "Show the parent of the current branch",
    },
    {
      name: "pop",
      description:
        "Delete the current branch but reaint the state of files in the working tree",
    },
    {
      name: "pr",
      description:
        "Opens the pull request page for a branch or PR number. If no branch is passed, the current branch's PR is opened",
      args: {
        name: "branch",
        description: "A branch name or PR number to open",
      },
    },
    {
      name: ["rename", "rn"],
      description:
        "Rename a branch and update metadata referencing it. If no branch name is supplied, you will be prompted for a new branch name. Note that this removes any associated GitHub pull request",
      args: {
        name: "name",
        description: "Branch name",
      },
      options: [
        {
          name: ["--force", "-f"],
          description:
            "Allow renaming a branch that is already associated with an open GitHub pull request",
        },
      ],
    },
    {
      name: "reorder",
      description:
        "Reorder branches between trunk and the current branch, restacking all of their descendants. Opens an editor where you can reorder branches by moving around a line corresponding to each branch",
    },
    {
      name: ["restack", "r"],
      description:
        "Ensure the current branch is based on its parent, rebasing if necessary. If conflicts are encountered, you will be prompted to resolve them via an interactive Git rebase",
      options: [
        {
          name: "--branch",
          description:
            "Which branch to run this command from. Defaults to the current branch",
          args: {
            name: "branch",
            description: "Name of the branch",
          },
        },
        {
          name: "--downstack",
          description: "Only restack this branch and its ancestors",
        },
        {
          name: "--only",
          description: "Only restack this branch",
        },
        {
          name: "--upstack",
          description: "Only restack this branch and its descendants",
        },
      ],
    },
    {
      name: "revert",
      description:
        "Create a branch that reverts a commit on the trunk branch. Currently experimental",
      args: {
        name: "sha",
        description: "The commit to revert",
      },
      options: [
        {
          name: ["--edit", "-e"],
          description: "Edit the commit message",
        },
      ],
    },
    {
      name: ["split", "sp"],
      description:
        "Split the current branch into multiple single-commit branches",
      options: [
        {
          name: ["--by-commit", "--commit", "-c"],
          description: "Split by commit - slice up the history of this branch",
        },
        {
          name: ["--by-hunk", "--hunk", "-h"],
          description: "Split by hunk - split into new single-commit branches",
        },
      ],
    },
    {
      name: ["squash", "sq"],
      description:
        "Squash all commits in the current branch and restack upstack branches",
      options: [
        {
          name: ["--message", "-m"],
          description: "The updated message for the commit",
          args: {
            name: "message",
            description: "Commit message",
          },
        },
        {
          name: "--edit",
          description: "Modify the existing commit message",
        },
        {
          name: ["--no-edit", "-n"],
          description:
            "Don't modify the existing commit message. Takes precedence over --edit",
        },
      ],
    },
    {
      name: ["submit", "s"],
      description:
        "Idempotently force push the current branch to GitHub, creating or updating a pull request.  Opens an interactive prompt that allows you to input pull request metadata. 'gt ss' is a default alias for 'gt submit --stack'",
      options: submitOptions,
    },
    {
      name: "sync",
      description:
        "Pull the trunk branch from remote and prompt to delete any branches that have been merged. Restacks all branches in your repository that can be restacked without conflicts. If trunk cannot be fast-forwarded to match remote, overwrites trunk with the remote version",
      options: [
        {
          name: "--delete",
          description:
            "Delete merged branches (true by default; skip with --no-delete)",
        },
        {
          name: ["--force", "-f"],
          description:
            "Don't prompt for confirmation before deleting a branch or overwriting trunk to match remote if it can't be fast-forwarded",
        },
        {
          name: "--pull",
          description:
            "Pull the trunk branch from remote (true by default; skip with --no-pull)",
        },
        {
          name: "--restack",
          description:
            "Restack any branches that can be restacked without conflicts (true by default; skip with --no-restack)",
        },
        {
          name: "--show-delete-progress",
          description: "Show progress through merged branches",
        },
      ],
    },
    {
      name: ["top", "t"],
      description:
        "Switch to the tip branch of the current stack. Prompts if ambiguous",
    },
    {
      name: ["track", "tr"],
      description:
        "Start tracking the current (or provided) branch with Graphite by selecting its parent. This command can also be used to fix corrupted Graphite metadata",
      args: {
        name: "branch",
        description: "Branch name",
      },
      options: [
        {
          name: ["--parent", "-p"],
          description:
            "The tracked branch's parent. If unset, prompts for a parent branch",
          args: {
            name: "parent",
            description: "Name of parent branch",
          },
        },
        {
          name: ["--force", "-f"],
          description:
            "Sets the parent to the most recent tracked ancestor of the branch being tracked. Takes precedence over `--parent`",
        },
      ],
    },
    {
      name: "trunk",
      description: "Switch to the trunk branch",
    },
    {
      name: ["untrack", "utr"],
      description:
        "Stop tracking a branch with Graphite. If the branch has children, they will also be untracked. Default to the current branch if none is passed in",
      args: {
        name: "branch",
        description: "Branch name",
      },
      options: [
        {
          name: ["--force", "-f"],
          description:
            "Will not prompt for confirmation before untracking a branch with children",
        },
      ],
    },
    {
      name: ["up", "u"],
      description:
        "Switch to the child of the current branch. Prompts if ambiguous",
      args: {
        name: "steps",
        description: "The number of levels to traverse upstack",
        isOptional: true,
        default: "1",
      },
      options: [
        {
          name: ["--steps", "-n"],
          description: "The number of levels to traverse upstack",
          args: {
            name: "steps",
            default: "1",
          },
        },
      ],
    },
  ],
  options: [
    {
      name: "--version",
      description: "Show Graphite CLI version",
      priority: 0,
      isPersistent: true,
    },
    {
      name: ["--help", "-h"],
      description: "Show help for Graphite CLI",
      priority: 20,
      isPersistent: true,
    },
    {
      name: "--interactive",
      description: "Prompt the user. Disable with --no-interactive",
      priority: 10,
      isPersistent: true,
    },
    {
      name: "--no-interactive",
      description: "Run non interactive",
      priority: 10,
      isPersistent: true,
    },
    {
      name: ["--quiet", "-q"],
      description: "Minimize output to the terminal. Implies --no-interactive",
      priority: 10,
      isPersistent: true,
    },
    {
      name: "--verify",
      description: "Run git hooks. Disable with --no-verify",
      priority: 10,
      isPersistent: true,
    },
    {
      name: "--no-verify",
      description: "Disable git hooks",
      priority: 10,
      isPersistent: true,
    },
    {
      name: "--debug",
      description: "Display debug output",
      priority: 10,
      isPersistent: true,
    },
    {
      name: "--cwd",
      description: "Working directory in which to perform operations",
      priority: 10,
      isPersistent: true,
    },
  ],
};

export default completionSpec;