Skip to content

BrandonAustin01/StructorCLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

πŸ—οΈ StructorCLI

StructorCLI is a blazing-fast, professional-grade CLI tool for scaffolding project structures using intelligent, reusable templates.

"Build the structure. Focus on creation."


πŸš€ Features

  • πŸ› οΈ Scaffold projects in seconds using interactive or flag-based CLI
  • πŸ“¦ Supports 30+ templates (Python, Node, Go, Rust, HTML, FastAPI, React, and more)
  • πŸ” Intelligent name injection using {{project_name}}
  • πŸ’‘ Dynamic template discovery β€” just drop in new folders under templates/
  • πŸ”„ Retry-friendly loop with error handling and validation
  • ✨ Motivational success quotes to keep your build vibe alive
  • 🎨 Beautiful rich output: tables, trees, panels, progress bars

πŸ“₯ Installation

# Clone the repo
git clone https://github.com/BrandonAustin01/StructorCLI.git
cd StructorCLI

# Install in editable (dev) mode
pip install -e .

Requires Python 3.8+


⚑ Usage

πŸ§‘β€πŸ”¬ Interactive Mode

structor

You'll be prompted to enter a project name and select a template visually.


πŸ’» Flag Mode

structor --template react --name my-app
Flag Description
--template Specify template folder name
--name Set project name without prompt
--help, -h Show help screen
--version, -v Show current StructorCLI version
--list, -l, list View all available templates
--quiet, -q Suppress extra output like quotes

πŸ“ Template Structure

All templates live inside:

src/structorcli/templates/

Each template folder can include any file structure.
You can use {{project_name}} inside any .md, .py, .json, etc.

Example injection:

{
  "name": "{{project_name}}",
  "version": "1.0.0"
}

Will become:

{
  "name": "my-app",
  "version": "1.0.0"
}

πŸ› οΈ Supported Templates (Sample)

  • βœ… Python / Flask / FastAPI
  • βœ… Node.js / Express
  • βœ… Bash
  • βœ… Go / Go-WebServer
  • βœ… Rust / Rust-CLI
  • βœ… HTML / Astro / Vite / Svelte / Vue / React
  • βœ… Django / PHP / Java / C++ / C# / Kotlin
  • βœ… Discord Bots (Node & Python)
  • βœ… GraphQL / Microservice / NestJS

Add your own by dropping a folder inside templates/


πŸ‘¨β€πŸ’» Author

Created by Brandon Austin
Built with 🦰, refined with πŸ’Ž, powered by Rich


⭐ Contribute

If you enjoy StructorCLI:

  • Star the repo ⭐
  • Add new templates
  • Open PRs or issues to help polish the experience

Let’s keep scaffolding smart.


About

πŸ—οΈStructorCLI is a blazing-fast, professional-grade CLI tool for scaffolding project structures using intelligent, reusable templates.

Topics

Resources

License

Stars

Watchers

Forks

Contributors