Skip to content

Support custom deployment names via CLI arguments #51

Open
@jeevanpillay

Description

@jeevanpillay

Description

Currently, when creating local Convex deployments, there's no way to specify a custom deployment name via
CLI arguments. This feature would allow developers to pass deployment names directly through the command
line, making it easier to manage multiple feature deployments.

Proposed Solution

Add support for a --name argument when creating local deployments:

npx convex dev --name feature/123

or

npx convex deploy --name feature/123

Use Case

When working with git worktrees or feature branches, developers often need to create isolated Convex
deployments for each feature. Currently, this requires manual configuration or environment variable
management. Being able to specify the deployment name directly via CLI would streamline this workflow.

Benefits

  • Easier management of multiple feature deployments
  • Better integration with git worktree workflows
  • Reduced configuration overhead for temporary deployments
  • More intuitive deployment naming for team collaboration

Example Workflow

Create a new feature branch deployment

git worktree add worktrees/feature-123 -b feature/123
cd worktrees/feature-123
npx convex dev --name feature/123

Each feature gets its own isolated Convex deployment

Additional Context

This would be particularly useful for teams using deployment strategies that involve multiple concurrent
feature branches, each needing their own isolated backend environment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions