Prerequisites

📦

Node.js

Version 18.0 or higher recommended

🐳

Docker

Optional for containerized deployments

🐍

Python

Version 3.9+ (for data pipeline modules)

🔑

API Key

Required for cloud sync & telemetry

Choose Your Method

Install via npm

Run the following command in your project root to add #divisions as a dependency.

bash
npm install @divisions/core@latest

Initialize Configuration

Run the setup wizard to generate your .divisionsrc file.

bash
npx divisions init

Start Development Server

Verify the installation by launching the local dev environment.

bash
npx divisions dev

Pull Official Image

Fetch the latest stable container from our registry.

bash
docker pull registry.divisions.io/core:latest

Run Container

Mount your config directory and expose the dashboard port.

bash
docker run -d \
  --name divisions-core \
  -v $(pwd)/.divisionsrc:/app/config \
  -p 3000:3000 \
  registry.divisions.io/core:latest

Install via pip

Requires Python 3.9+. Virtual environment recommended.

bash
pip install divisions-sdk

Authenticate & Configure

Set your environment variable and run the setup script.

bash
export DIVISIONS_API_KEY="your_key_here"
divisions setup --env production

Download Binary

Choose your OS architecture from the releases page.

Make Executable

bash
chmod +x divisions-cli
sudo mv divisions-cli /usr/local/bin/divisions

Run Setup

bash
divisions init --manual

✅ Verify Installation

Run the following command to confirm everything is configured correctly:

bash
divisions status --verbose

Expected output: ✔ Core v3.2.0 initialized followed by environment details.

Common Issues

  • Permission Denied: Run with sudo or fix npm/pip global permissions.
  • Port 3000 Busy: Change the default port with DIVISIONS_PORT=8080.
  • API Key Invalid: Regenerate from your dashboard or check env var syntax.
  • Docker Image Pull Failed: Ensure stable internet connection and correct auth for private registry.
💡 Still stuck?

Join our Developer Discord or open an issue on GitHub. Tag your post with #installation for faster response.