Solrevdev.SeedFolder

 _ __ _ _
 ___ ___ ___ __| |/ _| ___ | | __| | ___ _ __
 / __|/ _ \/ _ \/ _` | |_ / _ \| |/ _` |/ _ \ '__|
 \__ \ __/ __/ (_| | _| (_) | | (_| | __/ |
 |___/\___|\___|\__,_|_| \___/|_|\__,_|\___|_|

Overview

Quick Start

# Install globally
dotnet tool install --global solrevdev.seedfolder
# Interactive mode - choose template and folder name
seedfolder
# Create specific project types
seedfolder --template node myapp
seedfolder -t python data-analysis
seedfolder --type ruby my_gem
# Preview before creating
seedfolder --dry-run -t node myapp

Supported Project Templates

📝 markdown - Documentation Project (Default)

🏗️ dotnet - .NET Project

📦 node - Node.js Project

🐍 python - Python Project

💎 ruby - Ruby Project

🌐 universal - Basic Project

Command Line Interface

Usage: seedfolder [options] [folderName]
Options:
 --help, -h, -? Show this help message
 --version, -v Show version information
 --list-templates Show available template files
 --template, --type, -t Specify project template type
 --dry-run, --dry Preview operations without creating files
 --force, -f Overwrite existing directory and files
 --quiet, -q Suppress output (useful for scripting)
Arguments:
 folderName Name of the folder to create (optional)
Template Types:
 markdown Documentation project with README (default)
 dotnet .NET project with standard dotfiles
 node Node.js project with package.json
 python Python project with requirements.txt
 ruby Ruby project with Gemfile
 universal Basic project with minimal files

Usage Examples

Interactive Mode

# Start interactive mode with template selection
seedfolder
# Example interactive session:
 _ __ _ _
 ___ ___ ___ __| |/ _| ___ | | __| | ___ _ __
 / __|/ _ \/ _ \/ _` | |_ / _ \| |/ _` |/ _ \ '__|
 \__ \ __/ __/ (_| | _| (_) | | (_| | __/ |
 |___/\___|\___|\__,_|_| \___/|_|\__,_|\___|_|

▲さんかく Running in the path /current/directory
▲さんかく Available project templates:
 1. markdown - Documentation project with README
 2. dotnet - .NET project with standard dotfiles
 3. node - Node.js project with package.json
 4. python - Python project with requirements.txt
 5. ruby - Ruby project with Gemfile
 6. universal - Basic project with minimal files

▲さんかく Select template type (1-6) or press Enter for markdown: 3
▲さんかく Selected template: Node
▲さんかく Do you want to prefix the folder with the date? [Y/n] y
▲さんかく What do you want the folder to be named? my-awesome-app
‍▲さんかく Creating the directory 2024年01月15日_my-awesome-app
‍▲さんかく [1/7] Copying package.json
 ✅ Created 2024年01月15日_my-awesome-app/package.json
‍▲さんかく [2/7] Copying index.js
 ✅ Created 2024年01月15日_my-awesome-app/index.js
‍▲さんかく [3/7] Copying .gitignore
 ✅ Created 2024年01月15日_my-awesome-app/.gitignore
‍▲さんかく [4/7] Copying .gitattributes
 ✅ Created 2024年01月15日_my-awesome-app/.gitattributes
‍▲さんかく [5/7] Copying .editorconfig
 ✅ Created 2024年01月15日_my-awesome-app/.editorconfig
‍▲さんかく [6/7] Copying .prettierignore
 ✅ Created 2024年01月15日_my-awesome-app/.prettierignore
‍▲さんかく [7/7] Copying .prettierrc
 ✅ Created 2024年01月15日_my-awesome-app/.prettierrc
▲さんかく Done!
▲さんかく Successfully created 7 files in '2024年01月15日_my-awesome-app' using Node template.

▲さんかく To initialize git and make your first commit, copy and paste these commands:

cd "2024-01-15_my-awesome-app"
git init
git lfs install 2>/dev/null || echo "Git LFS not available"
git add .
git commit -m "Initial commit"

Direct Template Selection

# Create different project types
seedfolder --template node myapp
▲さんかく Using template type: Node
 _ __ _ _
 ___ ___ ___ __| |/ _| ___ | | __| | ___ _ __
 / __|/ _ \/ _ \/ _` | |_ / _ \| |/ _` |/ _ \ '__|
 \__ \ __/ __/ (_| | _| (_) | | (_| | __/ |
 |___/\___|\___|\__,_|_| \___/|_|\__,_|\___|_|

▲さんかく Running in the path /current/directory
‍▲さんかく Creating the directory myapp
‍▲さんかく [1/7] Copying package.json
 ✅ Created myapp/package.json
‍▲さんかく [2/7] Copying index.js
 ✅ Created myapp/index.js
‍▲さんかく [3/7] Copying .gitignore
 ✅ Created myapp/.gitignore
‍▲さんかく [4/7] Copying .gitattributes
 ✅ Created myapp/.gitattributes
‍▲さんかく [5/7] Copying .editorconfig
 ✅ Created myapp/.editorconfig
‍▲さんかく [6/7] Copying .prettierignore
 ✅ Created myapp/.prettierignore
‍▲さんかく [7/7] Copying .prettierrc
 ✅ Created myapp/.prettierrc
▲さんかく Done!
▲さんかく Successfully created 7 files in 'myapp' using Node template.

▲さんかく To initialize git and make your first commit, copy and paste these commands:

cd "myapp"
git init
git lfs install 2>/dev/null || echo "Git LFS not available"
git add .
git commit -m "Initial commit"

# Create Python project (spaces converted to dashes)
seedfolder -t python "machine learning project"
▲さんかく Using template type: Python
 _ __ _ _
 ___ ___ ___ __| |/ _| ___ | | __| | ___ _ __
 / __|/ _ \/ _ \/ _` | |_ / _ \| |/ _` |/ _ \ '__|
 \__ \  __/ __/ (_| | _| (_) | | (_| | __/ |
 |___/\___|\___|\__,_|_| \___/|_|\__,_|\___|_|
▲さんかく Running in the path /current/directory
‍▲さんかく Creating the directory machine-learning-project
‍▲さんかく [1/5] Copying main.py
 ✅ Created machine-learning-project/main.py
‍▲さんかく [2/5] Copying requirements.txt
 ✅ Created machine-learning-project/requirements.txt
‍▲さんかく [3/5] Copying .gitignore
 ✅ Created machine-learning-project/.gitignore
‍▲さんかく [4/5] Copying .gitattributes
 ✅ Created machine-learning-project/.gitattributes
‍▲さんかく [5/5] Copying .editorconfig
 ✅ Created machine-learning-project/.editorconfig
▲さんかく Done!
▲さんかく Successfully created 5 files in 'machine-learning-project' using Python template.
▲さんかく To initialize git and make your first commit, copy and paste these commands:
cd "machine-learning-project"
git init
git lfs install 2>/dev/null || echo "Git LFS not available"
git add .
git commit -m "Initial commit"
# Other examples
seedfolder --type ruby my_gem_name # Creates Ruby project
seedfolder -t markdown my-docs # Creates documentation project
seedfolder --template universal basic-project # Creates universal project
# Using folder name argument (skips interactive mode)
seedfolder myproject # Creates markdown project (default)
seedfolder --template python myapp # Creates Python project

Preview and Force Operations

# Preview what would be created (dry-run mode)
seedfolder --dry-run -t node myapp
▲さんかく Using template type: Node
 _ __ _ _
 ___ ___ ___ __| |/ _| ___ | | __| | ___ _ __
 / __|/ _ \/ _ \/ _` | |_ / _ \| |/ _` |/ _ \ '__|
 \__ \ __/ __/ (_| | _| (_) | | (_| | __/ |
 |___/\___|\___|\__,_|_| \___/|_|\__,_|\___|_|

▲さんかく Running in the path /current/directory
▲さんかく DRY RUN: Would create directory 'myapp' with template 'Node'
▲さんかく Files that would be created:
 • myapp/package.json
 • myapp/index.js
 • myapp/.gitignore
 • myapp/.gitattributes
 • myapp/.editorconfig
 • myapp/.prettierignore
 • myapp/.prettierrc
▲さんかく Use without --dry-run to actually create the files.

# Force overwrite existing directory
seedfolder --force existing-directory
▲さんかく Warning: Directory 'existing-directory' exists, will overwrite files.
‍▲さんかく Creating the directory existing-directory
‍▲さんかく [1/4] Copying README.md
 ✅ Created existing-directory/README.md
‍▲さんかく [2/4] Copying .gitignore
 ✅ Created existing-directory/.gitignore
‍▲さんかく [3/4] Copying .gitattributes
 ✅ Created existing-directory/.gitattributes
‍▲さんかく [4/4] Copying .editorconfig
 ✅ Created existing-directory/.editorconfig
▲さんかく Done!
▲さんかく Successfully created 4 files in 'existing-directory' using Markdown template.

▲さんかく To initialize git and make your first commit, copy and paste these commands:

cd "existing-directory"
git init
git lfs install 2>/dev/null || echo "Git LFS not available"
git add .
git commit -m "Initial commit"

# Quiet mode for scripting (no output shown)
seedfolder --quiet -t node myapp

Template Information

# List all available templates with file details
seedfolder --list-templates
▲さんかく Available project templates:
 markdown - Documentation project with README
 • README.md Project documentation
 • .gitignore Documentation specific git ignore patterns
 • .gitattributes Git attributes for documentation projects
 • .editorconfig Editor configuration for Markdown
 dotnet - Dotnet project with standard dotfiles
 • .dockerignore Docker ignore patterns
 • .editorconfig Editor configuration for .NET
 • .gitattributes Git attributes
 • .gitignore Git ignore patterns
 • .prettierignore Prettier ignore patterns
 • .prettierrc Prettier configuration
 • omnisharp.json OmniSharp configuration
 node - Node.js project with package.json
 • package.json Node.js package configuration
 • index.js Main application entry point
 • .gitignore Node.js specific git ignore patterns
 • .gitattributes Git attributes for Node.js projects
 • .editorconfig Editor configuration for Node.js
 • .prettierignore Prettier ignore patterns
 • .prettierrc Prettier configuration
 python - Python project with requirements.txt
 • main.py Main application entry point
 • requirements.txt Python dependencies
 • .gitignore Python specific git ignore patterns
 • .gitattributes Git attributes for Python projects
 • .editorconfig Editor configuration for Python
 ruby - Ruby project with Gemfile
 • Gemfile Ruby dependencies
 • main.rb Main application entry point
 • .gitignore Ruby specific git ignore patterns
 • .gitattributes Git attributes for Ruby projects
 • .editorconfig Editor configuration for Ruby
 universal - Basic project with minimal files
 • README.md Project documentation
 • .gitignore Basic git ignore patterns
 • .gitattributes Git attributes for universal projects
 • .editorconfig Editor configuration for universal projects
▲さんかく Usage examples:
 seedfolder --template node myproject
 seedfolder -t python myapp
 seedfolder --type ruby mygem
# Show version information
seedfolder --version
▲さんかく seedfolder version 1.3.1
# Show help
seedfolder --help
▲さんかく seedfolder version 1.3.1
▲さんかく Usage: seedfolder [options] [folderName]
Options:
 --help, -h, -? Show this help message
 --version, -v Show version information
 --list-templates Show available template files
 --template, --type, -t Specify project template type
 --dry-run, --dry Preview operations without creating files
 --force, -f Overwrite existing directory and files
 --quiet, -q Suppress output (useful for scripting)
Arguments:
 folderName Name of the folder to create (optional)
Template Types:
 dotnet .NET project with standard dotfiles
 node Node.js project with package.json
 python Python project with requirements.txt
 ruby Ruby project with Gemfile
 markdown Documentation project with README (default)
 universal Basic project with minimal files
Examples:
 seedfolder # Interactive mode with template selection
 seedfolder myproject # Create 'myproject' folder with markdown template
 seedfolder --template node myapp # Create Node.js project
 seedfolder -t python "my project" # Create Python project (spaces converted to dashes)
 seedfolder --type ruby mygem # Create Ruby project
 seedfolder --dry-run -t node myapp # Preview Node.js project creation
 seedfolder --force myproject # Overwrite existing 'myproject' directory
 seedfolder --quiet -t python myapp # Create Python project with no output

Advanced Features

🛡️ Error Handling & Validation

📊 Progress Indicators

‍▲さんかく [1/5] Copying main.py
 ✅ Created test-python/main.py
‍▲さんかく [2/5] Copying requirements.txt
 ✅ Created test-python/requirements.txt
‍▲さんかく [3/5] Copying .gitignore
 ✅ Created test-python/.gitignore
‍▲さんかく [4/5] Copying .gitattributes
 ✅ Created test-python/.gitattributes
‍▲さんかく [5/5] Copying .editorconfig
 ✅ Created test-python/.editorconfig
▲さんかく Done!
▲さんかく Successfully created 5 files in 'test-python' using Python template.
▲さんかく To initialize git and make your first commit, copy and paste these commands:
cd "test-python"
git init
git lfs install 2>/dev/null || echo "Git LFS not available"
git add .
git commit -m "Initial commit"

🔄 Smart Input Handling

Requirements

Installation

From NuGet (Recommended)

dotnet tool install --global solrevdev.seedfolder

Local Development Installation

# Clone the repository
git clone https://github.com/solrevdev/seedfolder.git
cd seedfolder
# Build and install locally
dotnet pack -c release -o artifacts/nupkg
dotnet tool uninstall -g solrevdev.seedfolder # If previously installed
dotnet tool install -g --add-source artifacts/nupkg solrevdev.seedfolder

Uninstall

dotnet tool uninstall --global solrevdev.seedfolder

Development

Local Testing

## Run directly during development
# Interactive mode
dotnet run --project src/solrevdev.seedfolder.csproj --framework net10.0
## With arguments
# Show the application's version (pass `--version` to the app via `--`)
dotnet run --project src/solrevdev.seedfolder.csproj --framework net10.0 -- --version
# Show the application's help text (pass `--help` to the app via `--`)
dotnet run --project src/solrevdev.seedfolder.csproj --framework net10.0 -- --help
# Create a Node template project using the app (arguments after `--` are for the app)
dotnet run --project src/solrevdev.seedfolder.csproj --framework net10.0 -- --template node myapp
# If you omit `--` and run `dotnet run --project ... --help`, the .NET CLI help will be shown.

Building and Testing

# Build the project
dotnet build
# Run tests
dotnet test
# Create package
dotnet pack -c release

Roadmap

✅ Completed (v1.3.x)

🔮 Future Enhancements

Contributing

Publishing to NuGet

<Version>1.3.2</Version>

License

Support