@octoherd/cli/index.d.ts

CLI to run a custom script on one or multiple repositories

import { octoherd } from "./index.js";
import { components } from "@octokit/openapi-types";

export { Octokit } from "@octoherd/octokit";
export type Repository = components["schemas"]["repository"];

export type OctoherdOptions = {
  /** The Octoherd Script function */
  octoherdScript: Function;
  /** Personal Access Token: Requires the "public_repo" scope for public repositories, "repo" scope for private repositories. */
  octoherdToken: string;
  /** Array of repository names in the form of "repo-owner/repo-name". To match all repositories for an owner, pass "repo-owner/*" */
  octoherdRepos: string[];
  /** Cache responses for debugging */
  octoherdCache: boolean;
  /** Bypass confirmation prompts for mutating requests */
  octoherdBypassConfirms: boolean;

  /** `octoherdScript` may accept its own options */
  [key: string]: unknown;
};

/**
 * Find all releases in a GitHub repository or organization after a specified date
 */
export async function octoherd(options: OctoherdOptions): void;