Skip to main content
The Atlas CLI is a powerful command-line tool for creating, building, and managing Atlas Engine projects. It simplifies project setup, dependency management, and application packaging.

​
Installation

The Atlas CLI can be installed using Cargo: 
cargo install atlas-cli

​
Available Commands

The Atlas CLI provides three main commands:

​
create

Create a new Atlas Engine project with all necessary files and dependencies. 
atlas create <name> [path] [OPTIONS]
Learn more about project creation

​
pack

Build and package your Atlas application for distribution on the target platform. 
atlas pack [OPTIONS]
Learn more about packaging

​
run

Build and run your Atlas application locally for testing and development. 
atlas run [OPTIONS]
Learn more about running projects

​
Configuration File

All Atlas projects include an atlas.toml configuration file that defines project settings and packaging options: 
[project]
name = "MyProject"
app_name = "My Application"

[pack]
icon = "none"
supported_platforms = "all"
version = "1.0"
identifier = "com.example.myapp"

​
Project Configuration

  • name - Internal project name used in build configuration
  • app_name - Display name for the application (optional, defaults to name)

​
Pack Configuration

  • icon - Path to application icon file (relative to assets directory)
  • supported_platforms - Comma-separated list of platforms ("all", "macos", "linux", "windows")
  • version - Application version number (optional, defaults to “1.0”)
  • identifier - Bundle identifier for macOS apps (optional, defaults to “example”)

​
Common Workflows

1

Create a new project

atlas create MyGame
cd MyGame
2

Develop your application

Edit MyGame/main.cpp and add your game logic using the Atlas Engine API.
3

Test locally

atlas run
4

Package for distribution

atlas pack --release

​
Platform Support

The Atlas CLI supports building and packaging applications for:
  • macOS (creates .app bundles)
  • Linux (creates executable binaries)
  • Windows (creates executable binaries)
Platform-specific packaging and bundling is handled automatically based on the current operating system.

Build docs developers (and LLMs) love

Get started for freeTalk to us