Skip to main content

​
Get started in three steps

​
Step 1: Install the CLI

Install the ecge command-line tool globally:
npm i -g ecge
Verify the installation:
ecge --version
Create a new project directory and initialize it:
mkdir my-project && cd my-project
ecge init
This scaffolds a new project with the default configuration.
The init command creates a ecge.config.json file with sensible defaults.

​
Step 2: Configure your project

Open ecge.config.json and configure your project:
  1. Set the name field to your project name.
  2. Configure your environment settings for dev, staging, and production.
  3. Add any API keys or secrets to your .env file.
Never commit .env files to version control.
Run the local development server:
ecge dev
Your project will be available at http://localhost:3000.

​
Step 3: Deploy

  1. Commit and push your changes to your repository.
  2. Run ecge deploy or connect your repo for automatic deployments.
  3. Your project will be live in moments.

​
Next steps

Configuration

Learn about all available project settings.

Project structure

Understand how ecge organizes files and routes.

Code examples

Add syntax-highlighted code blocks to your pages.

API reference

Explore the ecge REST API.
Need help? Check the full documentation or reach out to support.