import { Command } from "@commander-js/extra-typings"; import { chalkStderr } from "chalk"; import { Context, oneoffContext } from "../bundler/context.js"; import { DeploymentSelectionOptions, DetailedDeploymentCredentials, loadSelectedDeploymentCredentials, } from "./lib/api.js"; import { actionDescription } from "./lib/command.js"; import { ensureHasConvexDependency } from "./lib/utils/utils.js"; import { deploymentEnvBackend, envGet, envList, envRemove, envSet, } from "./lib/env.js"; import { getDeploymentSelection } from "./lib/deploymentSelection.js"; import { withRunningBackend } from "./lib/localDeployment/run.js"; import { envDefault } from "./envDefault.js"; const envSetCmd = new Command("set") // Pretend value is required .usage("[options] ") .arguments("[name] [value]") .summary("Set a variable") .description( "Set environment variables on your deployment.\n\n" + " npx convex env set NAME 'value'\n" + " npx convex env set NAME # omit a value to set one interactively\n" + " npx convex env set NAME --from-file value.txt\n" + " npx convex env set --from-file .env.defaults\n" + "When setting multiple values, it will refuse all changes if any " + "variables are already set to different values by default. " + "Pass --force to overwrite the provided values.\n", ) .option( "--from-file ", "Read environment variables from a .env file. Without --force, fails if any existing variable has a different value.", ) .option( "--force", "When setting multiple variables, overwrite existing environment variable values instead of failing on mismatch.", ) .configureHelp({ showGlobalOptions: true }) .allowExcessArguments(false) .action(async (name, value, cmdOptions, cmd) => { // Note: We use `as` here because optsWithGlobals() type inference doesn't // include global options from the parent command (added via addDeploymentSelectionOptions) const options = cmd.optsWithGlobals() as DeploymentSelectionOptions; const { ctx, deployment } = await selectEnvDeployment(options); await ensureHasConvexDependency(ctx, "env set"); await withRunningBackend({ ctx, deployment, action: async () => { const backend = deploymentEnvBackend(ctx, deployment); const didAnything = await envSet(ctx, backend, name, value, cmdOptions); if (didAnything === false) { cmd.outputHelp({ error: true }); return await ctx.crash({ exitCode: 1, errorType: "fatal", printedMessage: "error: No environment variables specified to be set.", }); } }, }); }); export async function selectEnvDeployment( options: DeploymentSelectionOptions, ): Promise<{ ctx: Context; deployment: { deploymentUrl: string; adminKey: string; deploymentNotice: string; deploymentFields: DetailedDeploymentCredentials["deploymentFields"]; }; }> { const ctx = await oneoffContext(options); const deploymentSelection = await getDeploymentSelection(ctx, options); const { adminKey, url: deploymentUrl, deploymentFields, } = await loadSelectedDeploymentCredentials(ctx, deploymentSelection, { ensureLocalRunning: false, }); const deploymentNotice = deploymentFields !== null ? ` (on ${chalkStderr.bold(deploymentFields.deploymentType)} deployment ${chalkStderr.bold(deploymentFields.deploymentName)})` : ""; const result = { ctx, deployment: { deploymentUrl, adminKey, deploymentNotice, deploymentFields, }, }; return result; } const envGetCmd = new Command("get") .arguments("") .summary("Print a variable's value") .description("Print a variable's value: `npx convex env get NAME`") .configureHelp({ showGlobalOptions: true }) .allowExcessArguments(false) .action(async (envVarName, _options, cmd) => { const options = cmd.optsWithGlobals(); const { ctx, deployment } = await selectEnvDeployment(options); await ensureHasConvexDependency(ctx, "env get"); await withRunningBackend({ ctx, deployment, action: async () => { const backend = deploymentEnvBackend(ctx, deployment); await envGet(ctx, backend, envVarName); }, }); }); const envRemoveCmd = new Command("remove") .alias("rm") .alias("unset") .arguments("") .summary("Unset a variable") .description( "Unset a variable: `npx convex env remove NAME`\n" + "If the variable doesn't exist, the command doesn't do anything and succeeds.", ) .configureHelp({ showGlobalOptions: true }) .allowExcessArguments(false) .action(async (name, _options, cmd) => { const options = cmd.optsWithGlobals(); const { ctx, deployment } = await selectEnvDeployment(options); await ensureHasConvexDependency(ctx, "env remove"); await withRunningBackend({ ctx, deployment, action: async () => { const backend = deploymentEnvBackend(ctx, deployment); await envRemove(ctx, backend, name); }, }); }); const envListCmd = new Command("list") .summary("List all variables") .description("List all variables: `npx convex env list`") .configureHelp({ showGlobalOptions: true }) .allowExcessArguments(false) .action(async (_options, cmd) => { const options = cmd.optsWithGlobals(); const { ctx, deployment } = await selectEnvDeployment(options); await ensureHasConvexDependency(ctx, "env list"); await withRunningBackend({ ctx, deployment, action: async () => { const backend = deploymentEnvBackend(ctx, deployment); await envList(ctx, backend); }, }); }); export const env = new Command("env") .summary("Set and view environment variables") .description( "Set and view environment variables on your deployment\n\n" + " Set a variable: `npx convex env set NAME 'value'`\n" + " Set interactively: `npx convex env set NAME`\n" + " Set multiple from file: `npx convex env set --from-file .env`\n" + " Unset a variable: `npx convex env remove NAME`\n" + " List all variables: `npx convex env list`\n" + " Print a variable's value: `npx convex env get NAME`\n\n" + "By default, this sets and views variables on your dev deployment.", ) .addCommand(envSetCmd) .addCommand(envGetCmd) .addCommand(envRemoveCmd) .addCommand(envListCmd) .addCommand(envDefault) .helpCommand(false) .addDeploymentSelectionOptions( actionDescription("Set and view environment variables on"), );