# yo-scripts

**Repository Path**: phyloong/yo-scripts

## Basic Information

- **Project Name**: yo-scripts
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-14
- **Last Updated**: 2026-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# yo-scripts

[中文](README.md) | English

A collection of personal PowerShell configuration scripts.

## Project Overview

yo-scripts is a set of scripts designed to personalize your PowerShell environment, including commonly used aliases, environment configurations, and custom functions to enhance command-line productivity.

## Contents

- **DOLLAR_PROFILE.ps1** - Entry point (PSReadLine setup + loads the other scripts)
- **core/** - Subfolder of core scripts, auto-loaded by the entry point (every `*.ps1` file it contains):
  - **aliases.ps1** - Custom command aliases
  - **envsetup.ps1** - Environment variable setup
  - **functions.ps1** - Custom PowerShell functions
- **setup.ps1** - One-click setup: wires the entry point into `$PROFILE` (idempotent)

## Usage

### Option 0: One-click setup

Run from the repo root (use `pwsh` or `powershell.exe` depending on which host's `$PROFILE` you want to configure):

```powershell
pwsh -File .\setup.ps1
```

The script locates `powershell\DOLLAR_PROFILE.ps1` in this repo, appends a dot-source line for it to the end of the current host's `$PROFILE` (creating the file if it does not exist), wrapped in a recognizable comment marker. **Idempotent** - re-running detects that it is already configured and skips. The repo can live anywhere.

Optional: `-ProfilePath <path>` to target a specific profile file (defaults to the current session's `$PROFILE`).

### Option 1: One-line source (recommended)

After cloning the repo, add a single line to your PowerShell profile `$PROFILE` (run `echo $PROFILE` to see its path; create the file if it does not exist; replace `<repo-path>` with the absolute path to the repo):

```powershell
. "<repo-path>\powershell\DOLLAR_PROFILE.ps1"
```

This entry point auto-loads the core scripts under the repo's `core/` subfolder, and loads machine-local scripts under `.completions/` and `.profiles/` from next to `$PROFILE` when present. Under PowerShell 7 it also loads extras from the `WindowsPowerShell` directory (the 5.1 profile home), so both shells share one local config. The repo can live anywhere - no need to copy the repo's scripts into `$PROFILE`'s directory.

### Option 2: Load individual scripts manually

```powershell
cd <repo-path>
. .\powershell\core\envsetup.ps1
. .\powershell\core\aliases.ps1
. .\powershell\core\functions.ps1
```

## License

MIT License