Getting Started

Get up and running with Aukimi in minutes. This guide covers installation, project setup, and basic configuration.

Installation

Install the Aukimi CLI globally using npm:

npm install -g @aukimi/cli

Verify the installation:

aukimi --version
# Output: Aukimi CLI v2.4.0

Create a Project

Initialize a new project with your preferred template:

aukimi init my-project --template=3d-standard
cd my-project
aukimi start

Available templates:

  • 3d-standard - Full 3D pipeline with sculpting and rendering
  • 2d-game - Pixel art and 2D animation workflow
  • audio-only - DAW Studio focused setup
  • blank - Empty project, choose modules manually

Pro Tip

Use --gpu-accelerated flag for faster rendering if you have a dedicated graphics card.