Skip to content

Local deployment fails due to undocumented Node.js v18.20.6 requirement #153

@jnchman

Description

@jnchman

The error message only specifies "Node.js v18" without indicating that the system specifically requires v18.20.6, which is specified in the .nvmrc file.

Expected Behavior

The system should either:

  1. Accept any Node.js v18.x or v18.20.x version, OR
  2. Clearly communicate the specific version requirement in both documentation and error messages

Problem

  • Current latest Node.js v18 LTS is v18.20.8
  • The specified requirement for v18.20.6 creates unnecessary friction
  • Documentation at https://docs.convex.dev/cli/local-deployments doesn't mention specific version requirements
  • Error message doesn't specify the exact version needed

Proposed Solutions

Option 1: Update .nvmrc to contain only 18 or 18.20 to allow flexibility:

  • This would enable nvm use to match any v18.* or v18.20.* version
  • Reduces friction for developers using newer patch versions

Option 2: Update to latest LTS and improve messaging:

  • Update .nvmrc to v18.20.8 (current LTS)
  • Update error message to specify exact version requirement
  • Update documentation to clearly state version requirements

Impact

This improvement would enhance developer experience by reducing setup friction and providing clearer environment configuration guidance.

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions