About       Getting Started       Zephyr       Troubleshoot       Contribution  

About 🚀

Zephyr Forge is a powerful utility designed to streamline the setup process for Zephyr development environments. It automates the entire configuration process, handling everything from dependency checks to Docker container management, allowing contributors to focus on development rather than environment setup.

[!IMPORTANT] Bun is required to be installed on your system, due to internal dependencies. Running npx zephyr-forge@latest setup can cause issues if Bun is not installed. So please make sure to install bun before running the setup command.

Getting Started 🌱

Using NPM

# Create a new Zephyr project
bunx zephyr-forge@latest init
# or use github packages
bunx @parazeeknova/zephyr-forge@latest init

# Initialize and start your development environment (First time recommended)
bunx zephyr-forge@latest setup

# Start development for an existing project
bunx zephyr-forge@latest dev

[!NOTE] Run npx zephyr-forge@latest --help for more information. If you are using Github Packages, replace zephyr-forge with @parazeeknova/zephyr-forge.

Features 🎉

🔁 Automated Environment Setup and Configuration: Zephyr Forge takes care of the entire setup process, ensuring that your development environment is configured correctly without manual intervention.

🐋 Docker Container Management: Seamlessly manage Docker containers, including creation, starting, stopping, and removal, to ensure a consistent development environment.

📦 Dependency Installation and Verification: Automatically install and verify all necessary dependencies, ensuring that your environment has everything it needs to function correctly.

🧹 Automatic Cleanup and Optimization: Keep your development environment clean and optimized by automatically removing unnecessary files and optimizing configurations.

🔍 Environment Health Checks: Regularly perform health checks on your environment to detect and resolve any issues that may arise, ensuring a stable development experience.

🚀 One-Command Deployment: Deploy your development environment with a single command, simplifying the process and reducing the potential for errors.

💻 Cross-Platform Support (Windows & Unix): Enjoy a seamless experience across different operating systems, with full support for both Windows and Unix-based systems.

// NPMjs Package - 🔗 npmjs.com/zephyr-forge

// Forge Homepage - 🔗 link

Troubleshoot 🛠

Having trouble? Open an issue

// Copyright © 2025 Parazeeknova