Skip to main content
Prerequisites:
  • Node.js version 19 or higher
  • A project directory with an ecge.config.json file
Follow these steps to set up your local development environment.
1

Install the ecge CLI

npm i -g ecge
2

Start the dev server

Navigate to your project directory and run:
ecge dev
A local preview will be available at http://localhost:3000.

​
Custom ports

By default, ecge uses port 3000. You can customize this with the --port flag: 
ecge dev --port 3333
If the port is already in use, ecge will automatically try the next available port: 
Port 3000 is already in use. Trying 3001 instead.

​
CLI versions

Each CLI release is tied to a specific platform version. If your local preview doesn’t match production, update the CLI: 
npm update -g ecge
The CLI can validate internal links across your project: 
ecge check-links

​
Deployment

When deployment succeeds, you’ll see a confirmation:
Deployment confirmation showing all checks have passed.

​
Editor setup

We recommend using an editor with MDX support. For VS Code, install the MDX extension for syntax highlighting and Prettier for formatting.

​
Troubleshooting

This is usually caused by an outdated Node.js version:
  1. Remove the current CLI: npm remove -g ecge
  2. Upgrade to Node v19 or higher.
  3. Reinstall: npm i -g ecge
Delete the cache directory and restart:
rm -rf ~/.ecge && ecge dev