Skip to content

README.md

Latest commit

 

History

History
87 lines (64 loc) · 2.4 KB

README.md

File metadata and controls

87 lines (64 loc) · 2.4 KB

setup-tools

AI-powered project scaffolder and genesis toolkit. Generates standardized project structures with opinionated defaults, AI assistant configurations, and git workflows.

Overview

setup-tools provides a universal project scaffolding system using PowerShell. It creates project structures, initializes git repositories with proper .gitignore configurations, and includes AI assistant templates (AGENTS.md, GUIDE.md) for consistent development workflows.

The name follows the convention generated by the tool itself: two 6-letter words connected by a hyphen.

Features

  • Universal Scaffolding: Creates src/, tests/, and config directories
  • Git Integration: Auto-initializes repos with sensible .gitignore
  • AI Workflows: Includes AGENTS.md and GUIDE.md for AI-assisted development
  • Naming: Generates unique project names from word lists or timestamps
  • VS Code Ready: Opens projects in VS Code after creation

Installation

  1. Clone this repository:

    git clone https://github.com/chocolatepcode/setup-tools.git
cd setup-tools

  2. Ensure the template directory exists at ~\.genesis\ with AGENTS.md and GUIDE.md.

  3. Load the genesis function:

    . .\genesis.ps1

Usage

Create a new project with an auto-generated name:

Invoke-Genesis

Create with a specific name:

Invoke-Genesis -ProjectName "my-awesome-project"

Use custom templates:

Invoke-Genesis -ProjectName "api-service" -TemplatePath "C:\custom\templates"

Project Structure

setup-tools/
├── .md/              # Local documentation (AGENTS.md, GUIDE.md, LOG.md)
├── src/              # Source code
├── tests/            # Test files
├── genesis.ps1       # Main scaffolding script
├── README.md         # This file
└── .gitignore        # Git ignore patterns

Configuration

Word List

Create ~\.genesis\words.txt with 6-letter words for project naming:

banana
camera
dragon

Templates

Place customizing templates at ~\.genesis\:

  • AGENTS.md - AI assistant rules with embedded .gitignore, README.md and LOG.md templates
  • GUIDE.md - Prompt library and workflow documentation
  • .vscode/ - VS Code settings

Requirements

  • PowerShell 5.1 or higher
  • Git (must be in PATH)
  • VS Code (optional, for auto-open feature)

License

MIT