Skip to content

iPoetDev/PSProfileTUI

PSProfileTUI

A Text User Interface (TUI) for managing PowerShell profiles and configurations with enhanced customization capabilities.

PowerShell Analysis Tests

Features

  • Interactive TUI for PowerShell profile management
  • Profile configuration visualization and editing
  • Cross-platform support (Windows, Linux, macOS)
  • Modular design for easy extensibility

Project Structure

PSProfileTUI/
├── .github/                    # GitHub templates and workflows
│   ├── ISSUE_TEMPLATE/        # Issue templates
│   ├── PULL_REQUEST_TEMPLATE/ # PR templates
│   └── workflows/             # GitHub Actions workflows
├── src/                       # Source code
│   ├── modules/               # PowerShell modules
│   │   └── PSProfile/        # Core profile module
│   │       ├── Core/         # Core functionality
│   │       │   ├── Configuration/
│   │       │   ├── Initialize/
│   │       │   └── Logging/
│   │       ├── Features/     # Feature modules
│   │       │   ├── Git/
│   │       │   ├── SSH/
│   │       │   ├── VirtualEnv/
│   │       │   └── WSL/
│   │       └── UI/           # User interface
│   │           ├── Menu/
│   │           └── Prompt/
│   └── profile/              # PowerShell profile configurations
├── tests/                     # Test files
├── docs/                      # Documentation
├── CHANGELOG.md              # Project-wide changes
├── PROJECTLOG.md            # Development history & decisions
├── CONTRIBUTING.md          # Contribution guidelines
├── CODE_OF_CONDUCT.md       # Code of conduct
├── LICENSE                  # License information
└── README.md               # This file

Documentation Structure

Project Documentation

Change Tracking

Module Documentation

PSProfile Module

Core Components

Features

User Interface

Module Directory Table of Contents

Module Documentation Changelog Features
PSProfile README CHANGELOG Main module
Core README - Configuration, Init, Logging
Features README - Git, SSH, VirtualEnv, WSL
UI README - Menu, Prompt

Getting Started

Prerequisites

  • PowerShell 7.0 or higher
  • Windows Terminal (recommended)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/PSProfileTUI.git
  1. Import the module:
Import-Module ./src/modules/PSProfileTUI
  1. Run the TUI:
Start-PSProfileTUI

Development

Quick Start

  1. Fork and clone the repository
  2. Read the Contribution Guide
  3. Check the Project History for context
  4. Make changes in relevant modules
  5. Update appropriate changelogs
  6. Submit a pull request

Change Management

  • Module changes are documented in respective module changelogs
  • Project-wide changes are summarized in root CHANGELOG.md
  • Architectural decisions are documented in PROJECTLOG.md

Module Development

  1. Each module has its own README.md with specific guidelines
  2. Follow the module's documentation structure
  3. Update module-specific changelog first
  4. Update project-level changelog after module changes
  5. Keep module documentation in sync with changes

See CONTRIBUTING.md for detailed development setup and guidelines.

Testing

# Run all tests
Invoke-Pester ./tests

# Run specific module tests
Invoke-Pester ./tests/PSProfile

Changelog

See CHANGELOG.md for project-wide changes and individual module changelogs for detailed changes:

License

This project is licensed under the terms included in the LICENSE file.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published