convex/src/cli/deployments.ts

Client for the Convex Cloud

import { Command } from "commander";
import { readProjectConfig } from "./lib/config.js";
import chalk from "chalk";
import { bigBrainAPI } from "./lib/utils.js";
import { oneoffContext } from "./lib/context.js";

type Deployment = {
  id: number;
  name: string;
  create_time: number;
  deployment_type: "dev" | "prod";
};

export const deployments = new Command("deployments")
  .description("List deployments associated with a project")
  .action(async () => {
    const ctx = oneoffContext;
    const { projectConfig: config } = await readProjectConfig(ctx);

    const url = `/teams/${config.team}/projects/${config.project}/deployments`;

    console.error(
      chalk.yellow(`Deployments for project ${config.team}/${config.project}`)
    );
    const deployments = (await bigBrainAPI(ctx, "GET", url)) as Deployment[];
    console.log(deployments);
    if (deployments.length === 0) {
      console.error(chalk.yellow(`No deployments exist for project`));
    }
  });