https://github.com/vishal-ahirwar/aura
Aura 🚀 — A cross-platform C++ project builder inspired by Rust's rustup. It handles dependencies using vcpkg, builds with CMake + Ninja, and compiles using Clang — ensuring seamless, error-free builds across Windows, Linux, and macOS. 💯
https://github.com/vishal-ahirwar/aura
cli cli-app cmake cpp linux windows
Last synced: about 1 year ago
JSON representation
Aura 🚀 — A cross-platform C++ project builder inspired by Rust's rustup. It handles dependencies using vcpkg, builds with CMake + Ninja, and compiles using Clang — ensuring seamless, error-free builds across Windows, Linux, and macOS. 💯
- Host: GitHub
- URL: https://github.com/vishal-ahirwar/aura
- Owner: vishal-ahirwar
- License: bsd-3-clause
- Created: 2022-04-29T05:53:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-16T14:14:12.000Z (about 1 year ago)
- Last Synced: 2025-03-16T15:23:49.027Z (about 1 year ago)
- Topics: cli, cli-app, cmake, cpp, linux, windows
- Language: C++
- Homepage:
- Size: 1.36 MB
- Stars: 9
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: License.txt
Awesome Lists containing this project
README
---
# Aura
[](https://opensource.org/licenses/BSD-3-Clause)
**Aura** is a powerful tool for C/C++ learners, designed to streamline the process of setting up and managing projects. With Aura, you can focus on learning and coding instead of dealing with repetitive tasks like creating folders, writing CMake files, or compiling manually.
---
## About
Learning C/C++ and tired of manually managing files, folders, and compilation? Aura automates these tasks by:
- **Automated Project Initialization**: Generate a professional-grade project structure complete with a `CMakeLists.txt` file.
- **Organized Folder Setup**: Start every project with a clean, intuitive folder hierarchy.
- **Default `.gitignore` Integration**: Avoid unnecessary clutter by including a pre-configured `.gitignore` file.
- **Seamless Library Management**: Leverage built-in Conan support to easily integrate external libraries into your project.
- **Quick Environment Setup**: Configure your entire C++ learning environment effortlessly with a single command.
- **Efficiency-Driven Commands**: Simplify repetitive tasks to focus more on learning and building your C++ skills.
No more starting from scratch every time you want to learn a new concept in C/C++! 😊
---
## Features
- **Automated Project Setup**: Quickly generate a new C/C++ project structure.
- **Compilation Commands**: Simplified commands for compiling and running code.
- **Integrated Unit Testing**: Easily set up and run unit tests.
- **External Library Support**: Add libraries using Conan package manager.
- **Build Automation**: A single command to compile and run your project.
- **Cross-Platform Support**: Works on Windows and Linux.
- **Package Management**: Manage dependencies with ease.
- **GDB Debugger Integration**: Debug your projects seamlessly.
- **Installer Creation**: Generate packaged builds for distribution.
- **Update & Fix Commands**: Keep Aura up-to-date and resolve installation issues.
---
Download the pre-build binaries for your platform
or
## Installation
### Prerequisites
Ensure the following tools are installed on your system:
- **Git**: [Download Git](https://git-scm.com/downloads)
- **CMake**: [Download CMake](https://cmake.org/download/)
- **G++** (Linux) or **MinGW** (Windows):
- Linux: Install via package manager (`sudo apt install build-essential`).
- Windows: [Download MinGW](https://github.com/brechtsanders/winlibs_mingw/releases/).
### Steps
1. Clone the repository:
```bash
git clone https://github.com/vishal-ahirwar/aura.git
cd aura
```
2. Build and install:
- **Linux**:
```
python3 build.py
```
- **Windows**:
```batch
python3 build.py
```
---
## Usage
Run Aura with the following syntax:
```bash
aura [command] projectname
```
### Available Commands
| Command | Description |
|------------------|-----------------------------------------------------------------------------------------------------|
| **create** | Create a new C/C++ project. Example: `aura create myProject` |
| **compile** | Compile the project. Example: `cd myProject && aura compile -DCMAKE_BUILD_TYPE=Debug` |
| **run** | Run the compiled binary. Ensure the project is compiled first. |
| **build** | Compile and run the project in a single step. |
| **setup** | Install `g++` and `cmake` on your system (if not already installed). |
| **utest** | Enable unit testing. Example: `aura create test --test` |
| **createinstaller** | Create a packaged build of your application. |
| **update** | Update Aura to the latest version. |
| **add** | Add an external library using Conan. Example: `aura add fmt/11.0.2` |
| **reload** | Reload the package list. Example: `aura reload`. |
| **initconan** | Add a Conan configuration file to the project. |
| **debug** | Start the GDB debugger for your project. |
| **release** | Compile the application in release mode. Example: `aura compile -DCMAKE_BUILD_TYPE=Release`. |
| **fix** | Fix Aura installation issues. |
---
## Demo Project
```
cd demo
aura compile
aura run
or
aura build
or
python3 build.py
```
## Author
Developed by **Vishal Ahirwar**.
Copyright © 2024 Vishal Ahirwar and all Contributors. All rights reserved.
---
## License
This project is licensed under the MIT License. See the [LICENSE](License.txt) file for details.
---