🚀 Structify CLI: Automate Project Structure with Ease

Setting up a project manually can be tedious, especially when organizing folders and files. Structify CLI is designed to make this process effortless by letting you define your project structure using a simple syntax.

This guide will take you through:
✅ Setting up a virtual environment.
✅ Installing Structify CLI.
✅ Initializing and generating a project.
✅ Future plans and enhancements.

---

📌 Step 1: Create a Project Directory

First, create a new folder for your project and navigate into it:

mkdir my_project && cd my_project

This ensures all project files remain in one place.

---

📌 Step 2: Set Up a Virtual Environment

A virtual environment (venv) is essential to isolate dependencies and avoid conflicts.

Run the following command to create a virtual environment inside your project folder:

python -m venv venv

✅ Activate the Virtual Environment

On Windows:

venv\Scripts\activate

On macOS/Linux:

source venv/bin/activate

After activation, your terminal will show (venv), indicating the environment is active.

---

📌 Step 3: Install Structify CLI

With the virtual environment activated, install Structify CLI using pip:

pip install structify-cli

✅ Expected Output

pgsqlCopyEditCollecting structify-cli
  Using cached structify_cli-0.1.0-py3-none-any.whl.metadata (192 bytes)
Using cached structify_cli-0.1.0-py3-none-any.whl (4.1 kB)
Installing collected packages: structify-cli
Successfully installed structify-cli-0.1.0

Now, structify is installed and ready to use.

---

📌 Step 4: Initialize a New Project

Run the following command inside your virtual environment:

structify init

✅ Interactive Prompt

Enter project name: Demo
Enter files and folders (use '/' for folders, ';' for root files, and '?' to nest inside last folder):

Here, you define the folder and file structure.

---

📌 Step 5: Define Project Structure

Use Structify’s custom syntax:

• / → Create a folder.

• ; → Separate files at the root level.

• ? → Nest a file inside the last created folder.

📌 Example Input

app.py; templates?index.html; static/style.css

✅ Expected Output

Structify will generate:

cppCopyEditDemo/
│── app.py
│── templates/
│   ├── index.html
│── static/
│   ├── style.css

📌 Another Example

Structure: app.py; requirements.txt; templates/index.html, main.html; static/style.css; scripts/app.js

✅ Generated Structure

cppCopyEditDemo/
│── app.py
│── requirements.txt
│── templates/
│   ├── index.html
│   ├── main.html
│── static/
│   ├── style.css
│── scripts/
│   ├── app.js

Once complete, Structify will confirm:

Project "Demo" created successfully.

---

📌 Step 6: Running Your Project

If your project has a Python file, test it by running:

python app.py

✅ Example Execution

PS C:\Users\ameer\OneDrive\Desktop\testing> & C:/Users/ameer/OneDrive/Desktop/testing/.venv/Scripts/python.exe C:/Users/ameer/OneDrive/Desktop/testing/main.py
Hello World!

---

🚀 Future Plans & Enhancements

Structify CLI is designed to be lightweight, fast, and flexible, but many powerful features are planned for future updates:

📌 Upcoming Features

✅ Predefined Templates – Generate structures for web apps, APIs, and CLI tools instantly.
✅ Custom Configuration Files – Save and reuse project structures.
✅ Dependency Management – Auto-create requirements.txt for Python projects.
✅ Version Control Initialization – Option to auto-initialize a Git repository.
✅ Multi-Language Support – Generate structures for JavaScript, Go, and Rust projects.
✅ GUI Tool – A graphical interface for easier project setup.

---

🎯 Conclusion

Structify CLI makes project setup seamless by automating folder and file creation. With virtual environments, you ensure projects remain organized without system-wide conflicts.

🚀 Try Structify today and speed up your workflow!

🔗 Get started:

mkdir my_project && cd my_project
python -m venv venv
source venv/bin/activate  # (or venv\Scripts\activate on Windows)
pip install structify-cli
structify init