Create Echo CMS

Official installer for Echo CMS - The customized, enterprise-ready content management system.

Quick Start

Create a new Echo CMS project with one command:

npx create-echo-cms my-project

What You Get

• ✅ Full Source Code Access - Complete Echo CMS core files
• ✅ Custom Database Schema - echocms_ prefixed tables
• ✅ Rebranded Interface - Echo CMS instead of Directus
• ✅ Extended Features - Additional functionality over standard Directus
• ✅ Enterprise Ready - Optimized for production use

Installation Options

Using npx with GitHub Token (Recommended)

npx create-echo-cms my-project --key=ghp_xxxxxxxxxxxxx
cd my-project
pnpm install
pnpm build
echo-cms init

Using SSH Authentication

npx create-echo-cms my-project --auth=ssh

Using Local Template (Development)

npx create-echo-cms my-project --local-path=/path/to/template

Advanced Options

# Custom template repository
npx create-echo-cms my-project --template-url=https://github.com/custom/repo.git

# Specific branch
npx create-echo-cms my-project --key=ghp_xxx --branch=develop

# All options
npx create-echo-cms my-project \
  --key=ghp_xxxxxxxxxxxxx \
  --branch=main \
  --template-url=https://github.com/EchoYazilim/echo-cms.git

Legacy Methods

# npm init
npm init create-echo-cms my-project

# yarn create
yarn create create-echo-cms my-project

# Environment variables (legacy)
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxx
npx create-echo-cms my-project

Project Structure

my-project/
├── api/          # Backend API (Node.js, Express)
├── app/          # Frontend Admin Panel (Vue.js)
├── packages/     # Internal packages
├── directus/     # CLI tools (echo-cms command)
└── sdk/          # JavaScript SDK

Requirements

• Node.js ≥ 16.0.0
• Git (for template download)
• Network access to GitHub

CLI Options

| Option | Description | Example | | ---------------------- | --------------------------------------- | --------------------------------------------------- | | --key <token> | GitHub personal access token | --key=ghp_xxxxx | | --token <token> | Alias for --key | --token=ghp_xxxxx | | --auth <method> | Authentication method (token/ssh/local) | --auth=ssh | | --template-url <url> | Custom template repository | --template-url=https://github.com/custom/repo.git | | --branch <branch> | Template branch to use | --branch=develop | | --local-path <path> | Use local template | --local-path=/path/to/template |

Authentication

GitHub Personal Access Token (Recommended)

1. Go to GitHub → Settings → Developer settings → Personal access tokens
2. Generate new token (classic)
3. Select scopes: repo (for private repository access)
4. Use with: npx create-echo-cms my-project --key=ghp_xxxxx

SSH Key Setup

1. Generate SSH key: ssh-keygen -t ed25519 -C "[email protected]"
2. Add to GitHub: Settings → SSH and GPG keys
3. Test: ssh -T [email protected]
4. Use with: npx create-echo-cms my-project --auth=ssh

Local Development

• Use --local-path for offline development
• Or set ECHO_CMS_TEMPLATE_PATH environment variable

Support

• 📧 Issues: https://github.com/EchoYazilim/echo-cms/issues
• 📖 Documentation: https://github.com/EchoYazilim/echo-cms#readme

License

GPL-3.0-only