Skip to main content

Getting Started

Installation - Xentralia Docs

Get Xentralia set up in your project in under 5 minutes. This guide covers installation, authentication, and your first deployment.

Getting started with Xentralia takes just a few minutes. This guide will walk you through installation, authentication, and deploying your first project.

Prerequisites

Before you begin, make sure you have:

  • Node.js 18+ installed on your machine
  • A Xentralia account (sign up at xentralia.com)
  • Git installed and configured

Install the CLI

The Xentralia CLI is the primary way to interact with the platform. Install it globally:

npm install -g @xentralia/cli

Verify the installation:

xentralia --version

Authenticate

Log in to your Xentralia account:

xentralia login

This opens your browser for authentication. Once complete, you’re ready to create projects.

Initialize Your Project

Navigate to your project directory and initialize Xentralia:

cd your-project
xentralia init

This creates a xentralia.config.js file with sensible defaults:

export default {
  name: 'your-project',
  framework: 'auto', // Xentralia auto-detects your framework
  buildCommand: 'npm run build',
  outputDirectory: 'dist',
};

Deploy

Deploy your project with a single command:

xentralia deploy

That’s it! Xentralia will:

  1. Build your project
  2. Upload the artifacts
  3. Deploy to a preview URL
  4. Return the live URL

Next Steps

Now that you’re set up:

Troubleshooting

”Command not found: xentralia”

Make sure npm’s global bin directory is in your PATH. Run npm bin -g to find the location.

Authentication Issues

Try logging out and back in:

xentralia logout
xentralia login

Build Failures

Check that your build command works locally before deploying:

npm run build

Still stuck? Join our Discord for help from the community.