### Install Applications to System Drive Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Demonstrates how to define an installation path relative to the detected system drive. ```powershell $sysDrive = Get-SystemDrive $programFiles = "$sysDrive\Program Files\MyApp" # Install to system drive ``` -------------------------------- ### Pipeline Usage Example Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Demonstrates how to safely pipe the output of registry path retrieval. ```powershell Get-RegUserPaths | ForEach-Object { ... } ``` -------------------------------- ### Fresh Windows Installation Workflow Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/README.md High-level steps for applying the Atlas playbook via the AME Wizard. ```powershell # 1. Run Atlas playbook through AME Wizard # 2. Select customization options # 3. System applies all configurations # 4. New users get proper configuration on first login ``` -------------------------------- ### Create Start Menu Shortcuts with PowerShell Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Generates a shortcut within the user's Start Menu Programs folder. ```powershell $startMenu = [Environment]::GetFolderPath('StartMenu') New-Shortcut -Source "C:\Program Files\MyApp\MyApp.exe" ` -Destination "$startMenu\Programs\MyApp\Main App.lnk" ``` -------------------------------- ### Complete Theme Setup Script Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Automates the application of a theme, MRU configuration, lockscreen update, and process cleanup. ```powershell # Import theme module & "$windir\AtlasModules\initPowerShell.ps1" # Apply theme and configure MRU Set-Theme -Path "$env:windir\Resources\Themes\atlas-v0.5.x-dark.theme" Set-ThemeMRU Set-LockscreenImage # Stop processes to finalize Stop-ThemeProcesses ``` -------------------------------- ### Configure New User Profiles Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Defines the administrative requirements for the user setup script. This script is triggered automatically during provisioning. ```powershell #Requires -RunAsAdministrator # (Script body performs user environment setup and logoff) ``` -------------------------------- ### Registry Import Format Example Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Standard Windows Registry Editor format for defining keys, values, and deletions. ```reg Windows Registry Editor Version 5.00 [HKEY_LOCAL_MACHINE\SOFTWARE\AtlasOS] "Version"="1.0" [HKEY_CURRENT_USER\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Advanced] "Hidden"=dword:00000001 "HideFileExt"=dword:00000000 [-HKEY_LOCAL_MACHINE\SOFTWARE\ToRemove] ``` -------------------------------- ### Get-SystemDrive Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the system drive letter where Windows is installed. ```APIDOC ## Get-SystemDrive ### Description Detects and returns the system drive letter (e.g., "C:") where Windows is installed. ### Return Value - **string** - The system drive letter with a colon. ### Throws - **string** - Thrown when the system drive cannot be determined. ``` -------------------------------- ### Retrieve Shell Quick Access GUID Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md The GUID used for the Shell Quick Access location. ```text CLSID: {679f85cb-0220-4080-b29b-5540cc05aab6} ``` -------------------------------- ### Get-UserPath Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves a system folder path based on a provided GUID. ```APIDOC ## Get-UserPath ### Description Retrieves the path for a specific system folder identified by a GUID. ### Parameters - **FolderID** (String) - Required - The GUID representing the target system folder. ### Errors - **Failed to convert provided FolderID!**: Returned if the GUID format is invalid. - **Failed to retrieve {GUID}. Error code: {code}**: Returned if the folder cannot be accessed. - **Failed to retrieve {GUID}. Error code: E_INVALIDARG**: Returned if the provided token is invalid. ``` -------------------------------- ### Disable-StartMenuRecommendations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Disables Iris recommendations and account notifications in the Start Menu. ```powershell function Disable-StartMenuRecommendations ``` -------------------------------- ### Disable-DeviceSetupSuggestions Function Definition Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Defines the function to disable lock screen setup suggestions. ```powershell function Disable-DeviceSetupSuggestions ``` -------------------------------- ### Atlas Configuration Execution Order Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md The sequence in which YAML configuration files are processed during the Atlas OS setup process. ```text 1. start.yml — Initialize 2. default.yml — Apply defaults 3. services.yml — Configure services 4. components.yml — Remove components 5. appx.yml — Remove UWP apps 6. tweaks.yml — Apply selected tweaks └── User selections └── Individual tweak YAMLs 7. custom.yml — Apply customizations ``` -------------------------------- ### Get System Drive Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the system drive letter and displays it to the console. ```powershell $sysDrive = Get-SystemDrive Write-Host "System Drive: $sysDrive" # Output: System Drive: C: ``` -------------------------------- ### Retrieve Documents Folder Path Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Fetches a specific folder path by providing its corresponding GUID. ```powershell $docGuid = 'FDD39AD0-238F-46AF-ADB4-6C85480369C7' $documentsPath = Get-UserPath -FolderID $docGuid Write-Host "Documents: $documentsPath" ``` -------------------------------- ### Disable-FrequentApps Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Prevents Windows from displaying frequently-used applications in the Start Menu. ```powershell function Disable-FrequentApps ``` -------------------------------- ### Get-SystemDrive Function Definition Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the system drive letter where Windows is installed. ```powershell function Get-SystemDrive ``` -------------------------------- ### Atlas Registry Configuration Storage Paths Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Registry keys used by Atlas OS to store installation state, user choices, and version information. ```powershell HKLM:\SOFTWARE\AtlasOS\ Setup/ — Installation state SetupOptions/ — User choices Version/ — Atlas version info HKCU:\SOFTWARE\AtlasOS\ User/ — Per-user settings ``` -------------------------------- ### Get-UserPath Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the full file system path to a well-known Windows folder using its GUID. Supports specifying user tokens and custom Shell API flags. ```APIDOC ## Get-UserPath ### Description Retrieves the full path to a well-known Windows user folder using Shell APIs. It supports both current user and default user profiles and can automatically create the folder if it does not exist. ### Parameters - **FolderID** (string) - Optional - GUID of the well-known folder (Default: B4BFCC3A-DB2C-424C-B029-7FE99A87C641). - **Token** (System.IntPtr) - Optional - User token (0 = current user, -1 = default user, Default: -1). - **Flags** (int) - Optional - SHGetKnownFolderPath flags (Default: 0x00008000). ### Return Value - **Type**: string - **Description**: The complete file system path to the requested folder. ### Throws - **Error**: Throws a string error if the folder GUID is invalid or the path cannot be retrieved. ``` -------------------------------- ### Usage of Add-MusicVideosToHome Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Executes the function to add missing Quick Access folders. ```powershell # Add missing Quick Access folders Add-MusicVideosToHome # Verify with File Explorer # Music and Videos should now appear in sidebar ``` -------------------------------- ### Apply All Performance Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/performance-module.md Initializes the module and executes the full suite of performance optimizations. ```powershell # Import the module & "$windir\AtlasModules\initPowerShell.ps1" # Run all optimizations Invoke-AllPerformanceOptimizations ``` -------------------------------- ### Disable-ErrorReporting Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Disables error reporting for Windows, applications, and device installation. ```powershell function Disable-ErrorReporting ``` -------------------------------- ### Create Shortcuts in User Folders Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Demonstrates creating shortcuts using paths retrieved from the module. ```powershell $desktop = Get-UserPath # Gets desktop GUID by default $documents = Get-UserPath -FolderID 'FDD39AD0-238F-46AF-ADB4-6C85480369C7' New-Shortcut -Source "notepad.exe" -Destination "$desktop\Notepad.lnk" New-Shortcut -Source "explorer.exe" -Destination "$documents\File Explorer.lnk" ``` -------------------------------- ### Create a basic shortcut Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Creates a standard shortcut pointing to an executable file. ```powershell New-Shortcut -Source "C:\Program Files\SomeApp\app.exe" ` -Destination "$env:USERPROFILE\Desktop\MyApp.lnk" ``` -------------------------------- ### Integrate with Qol Module Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Demonstrates applying Quality of Life registry customizations to all user hives. ```powershell # Apply QoL settings to all users $userHives = Get-RegUserPaths -NoDefault foreach ($hive in $userHives) { # Apply explorer customizations Set-ItemProperty -Path "$($hive.PSPath)\Software\Microsoft\Windows\CurrentVersion\Explorer\Advanced" ` -Name "LaunchTo" -Value 1 -Force } ``` -------------------------------- ### Integrate with Utils Module Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Demonstrates retrieving user registry paths and resetting processes using the Utils module pattern. ```powershell # Apply settings, then reset processes $userHives = Get-RegUserPaths -NoDefault foreach ($hive in $userHives) { # Modify user registry } # Refresh explorer for all users Stop-Process -Name explorer -Force -EA 0 ``` -------------------------------- ### Set-ContentDelivery Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Disables content delivery features to prevent future unwanted app installations. ```APIDOC ## Set-ContentDelivery ### Description Configures the system to disable content delivery services. ### Usage ```powershell & "$windir\AtlasModules\initPowerShell.ps1" Set-ContentDelivery ``` ``` -------------------------------- ### Invoke-AllMiscSystemUtilities Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Executes all miscellaneous system utility functions in sequence, including adding music videos to home, setting time servers, and resetting performance counters. ```APIDOC ## Invoke-AllMiscSystemUtilities ### Description Master function that runs all individual miscellaneous utility functions with console output. ### Signature `Invoke-AllMiscSystemUtilities` ### Parameters - None ### Return Type void ### Usage Example ```powershell Invoke-AllMiscSystemUtilities ``` ``` -------------------------------- ### Initialize System Utilities Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Script to initialize the PowerShell environment and apply all miscellaneous system utilities. ```powershell # Import module $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" Import-Module Miscellaneous # Apply all miscellaneous utilities Invoke-AllMiscSystemUtilities Write-Host "System utilities configured" ``` -------------------------------- ### Apply Specific Performance Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/performance-module.md Initializes the module and executes targeted optimizations for filesystem and game-related settings. ```powershell # Import the module & "$windir\AtlasModules\initPowerShell.ps1" # Apply only filesystem optimization Optimize-NTFS # Apply only game-related optimizations Disable-GameBar ``` -------------------------------- ### Create Shortcut via WScript.Shell Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Initializes the COM object and creates a shortcut instance at the specified destination. ```powershell $WshShell = New-Object -ComObject WScript.Shell $Shortcut = $WshShell.CreateShortcut($Destination) ``` -------------------------------- ### Applying Specific Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/README.md Initialize the environment and invoke performance or privacy-specific optimization modules. ```powershell & "$windir\AtlasModules\initPowerShell.ps1" Import-Module Performance Invoke-AllPerformanceOptimizations Import-Module Privacy Invoke-AllPrivacyOptimizations ``` -------------------------------- ### Apply a theme file Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Applies a specific .theme file to the system. ```powershell $themePath = "$env:windir\Resources\Themes\atlas-v0.5.x-dark.theme" Set-Theme -Path $themePath ``` -------------------------------- ### New-Shortcut Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Creates a Windows shortcut file pointing to an executable or command with customizable properties. ```APIDOC ## New-Shortcut ### Description Creates a Windows shortcut file (.lnk) pointing to an executable or command. Validates that the source exists and supports optional custom icons and arguments. ### Parameters - **Source** (string) - Required - Path to executable or command name to execute. - **Destination** (string) - Required - Full path where shortcut file (.lnk) will be created. - **WorkingDir** (string) - Optional - Working directory for the shortcut. Defaults to source directory. - **Arguments** (string) - Optional - Command-line arguments to pass to the executable. - **Icon** (string) - Optional - Path to custom icon file (.ico, .exe, .dll). - **IfExist** (switch) - Optional - Only create shortcut if destination already exists. ### Return Type void ### Throws - [string] - When Source not found or invalid ``` -------------------------------- ### Apply All Atlas Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Initializes the environment and executes performance, privacy, and debloat optimization modules. ```powershell # Initialize environment $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" # Import modules Import-Module Performance Import-Module Privacy Import-Module Debloat # Run optimizations Invoke-AllPerformanceOptimizations Invoke-AllPrivacyOptimizations Invoke-AllDebloatOptimizations ``` -------------------------------- ### IThemeManager COM Interface Definition Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Defines the COM interface for Windows theme management with specific GUID and method signatures. ```csharp [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] [Guid("0646EBBE-C1B7-4045-8FD0-FFD65D3FC792")] public interface IThemeManager { [DispId(1610678272)] ITheme CurrentTheme { get; } [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)] void ApplyTheme([MarshalAs(UnmanagedType.BStr)] string themeFilePath); } ``` -------------------------------- ### Apply All Privacy Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Initializes the environment and executes the full suite of privacy optimizations available in the module. ```powershell # Import module & "$windir\AtlasModules\initPowerShell.ps1" # Run all privacy optimizations Invoke-AllPrivacyOptimizations ``` -------------------------------- ### Disable Windows Content Delivery Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Disables promotional content, app suggestions, and pre-installed app installations by modifying registry keys. ```powershell function Set-ContentDelivery ``` -------------------------------- ### New-Shortcut Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Creates a new Windows shortcut file at the specified destination pointing to the provided source executable or command. ```APIDOC ## New-Shortcut ### Description Creates a shortcut file (.lnk) on the filesystem. It validates the source executable and allows configuration of working directories, arguments, and custom icons. ### Parameters - **Source** (string) - Required - Absolute/relative file path to an executable or a command name resolvable by Get-Command. - **Destination** (string) - Required - The full path where the shortcut will be created (should end in .lnk). - **WorkingDir** (string) - Optional - The working directory for the shortcut. Defaults to the source directory or System32. - **Arguments** (string) - Optional - Command-line arguments to pass to the target executable. - **Icon** (string) - Optional - Path to an .ico, .exe, or .dll file to use as the shortcut icon. - **IfExist** (switch) - Optional - If enabled, the shortcut is only created if the destination path already exists. ### Usage Example New-Shortcut -Source "C:\Program Files\SomeApp\app.exe" -Destination "$env:USERPROFILE\Desktop\MyApp.lnk" ``` -------------------------------- ### Create Taskbar Pinned Shortcuts with PowerShell Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Creates a shortcut file in the temp directory as a prerequisite for taskbar pinning. ```powershell # Note: Pinning to taskbar requires additional mechanisms beyond shortcut creation New-Shortcut -Source "firefox.exe" ` -Destination "$env:TEMP\firefox.lnk" ``` -------------------------------- ### Configure Quick Access Folders Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Idempotent command to add missing folders to Quick Access. ```powershell # Add missing folders to Quick Access Add-MusicVideosToHome # Can be run anytime, idempotent ``` -------------------------------- ### Get-UserPath Function Definition Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Defines the Get-UserPath function signature for retrieving Windows folder paths. Uses default parameters for the Desktop GUID and current user token. ```powershell function Get-UserPath { param ( [string]$FolderID = 'B4BFCC3A-DB2C-424C-B029-7FE99A87C641', [System.IntPtr]$Token = -1, [int]$Flags = 0x00008000 ) } ``` -------------------------------- ### Create a shortcut with custom icon and working directory Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Specifies a custom working directory and an icon file for the shortcut. ```powershell New-Shortcut -Source "cmd.exe" ` -Destination "C:\shortcuts\command-prompt.lnk" ` -WorkingDir "C:\projects\" ` -Icon "C:\custom-icons\cmd.ico" ``` -------------------------------- ### Apply All Debloating Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Executes the full suite of debloating optimizations after initializing the module environment. ```powershell # Import the module & "$windir\AtlasModules\initPowerShell.ps1" # Run all debloating optimizations Invoke-AllDebloatOptimizations ``` -------------------------------- ### Create Desktop Shortcuts with PowerShell Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Iterates through an array of application objects to generate desktop shortcuts for each. ```powershell $apps = @( @{Source="notepad.exe"; Name="Notepad"}, @{Source="mspaint.exe"; Name="Paint"}, @{Source="calc.exe"; Name="Calculator"} ) foreach ($app in $apps) { New-Shortcut -Source $app.Source ` -Destination "$env:USERPROFILE\Desktop\$($app.Name).lnk" } ``` -------------------------------- ### Define Add-MusicVideosToHome Function Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Defines the function used to pin Music and Videos folders to the File Explorer Quick Access sidebar. ```powershell function Add-MusicVideosToHome ``` -------------------------------- ### Create a shortcut with arguments Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Passes command-line arguments to the target executable. ```powershell New-Shortcut -Source "powershell.exe" ` -Destination "$env:USERPROFILE\Desktop\PowerShell Admin.lnk" ` -Arguments "-NoExit -Command 'Write-Host Hello'" ``` -------------------------------- ### Multi-Boot System Handling Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the system drive for use in accessing boot configuration files on multi-boot systems. ```powershell # Get actual system drive even on multi-boot systems $systemDrive = Get-SystemDrive $bootConfig = "$systemDrive\boot.ini" ``` -------------------------------- ### Atlas OS Module Dependency Hierarchy Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/INDEX.md Visual representation of the initialization sequence and module dependencies for the Atlas OS project. ```text initPowerShell.ps1 (initializer) └─ Themes └─ Performance └─ Privacy └─ Debloat └─ QoL └─ Utils └─ AllRegistryUsers └─ UserPaths └─ Shortcuts └─ Miscellaneous └─ Scripts ``` -------------------------------- ### Invoke-AllDebloatOptimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Executes the full suite of debloating and system optimization tasks. ```APIDOC ## Invoke-AllDebloatOptimizations ### Description Runs all available debloating optimizations to improve system performance and reclaim disk space. ### Usage ```powershell & "$windir\AtlasModules\initPowerShell.ps1" Invoke-AllDebloatOptimizations ``` ``` -------------------------------- ### Initialize Atlas PowerShell Modules Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/README.md Load the Atlas environment and import a specific module for use in scripts. ```powershell $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" Import-Module ModuleName ``` -------------------------------- ### !writeStatus Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Displays a progress message to the user during configuration execution. ```APIDOC ## !writeStatus ### Description Displays a progress message to the user. ### Parameters - **status** (string) - Required - Message to display ### Example - !writeStatus: {status: 'Applying Atlas configuration'} ``` -------------------------------- ### Set-Theme Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Applies a Windows theme file to the system using COM interop with fallback to Explorer. ```APIDOC ## Set-Theme ### Description Applies a theme file to Windows using COM (ThemeManager) with automatic fallback to launching via Explorer. The theme file must exist and have a .theme extension. ### Parameters - **Path** (string) - Required - Full path to .theme file ### Usage Example ```powershell $themePath = "$env:windir\Resources\Themes\atlas-v0.5.x-dark.theme" Set-Theme -Path $themePath ``` ``` -------------------------------- ### Show-FullContextMenuOnItems Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Always shows the full context menu without prompt. ```APIDOC ## Show-FullContextMenuOnItems ### Description Prevents Windows from showing the simplified context menu on the first click. ### Registry Key - **Key**: HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer - **Value**: MultipleInvokePromptMinimum - **Data**: 100 ``` -------------------------------- ### Initialize Atlas Module Loader Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Standard initialization pattern for scripts to load Atlas modules and define environment paths. ```powershell $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" $atlasDesktop = "$windir\AtlasDesktop" $atlasModules = "$windir\AtlasModules" ``` -------------------------------- ### Execute All Debloat Optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Run the master function to apply all system debloating optimizations in sequence. ```powershell Invoke-AllDebloatOptimizations ``` -------------------------------- ### Execute all performance optimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/performance-module.md Run the master function to apply all performance tweaks in the predefined sequence. ```powershell Invoke-AllPerformanceOptimizations ``` -------------------------------- ### !cmd Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Executes a command-line command. ```APIDOC ## !cmd ### Description Execute command-line command. ### Parameters - **command** (string) - Required - Command to execute - **exeDir** (bool) - Optional - Use playbook directory as working directory (Default: false) - **wait** (bool) - Optional - Wait for completion before continuing (Default: false) - **runas** (enum) - Optional - Execution level: currentUser, currentUserElevated, system (Default: currentUser) - **noExit** (bool) - Optional - Keep console window open (Default: false) ### Example - !cmd: command: 'reg import settings.reg' exeDir: true wait: true runas: currentUserElevated ``` -------------------------------- ### Integrate Get-UserPath with Themes Module Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the user's desktop path to store and set a custom theme file. ```powershell # Get user's desktop to store custom theme $desktopPath = Get-UserPath # Desktop GUID $customTheme = "$desktopPath\custom.theme" Set-Theme -Path $customTheme ``` -------------------------------- ### Build Windows Directory Path Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Constructs a full path to a specific directory on the system drive. ```powershell $sysDrive = Get-SystemDrive $atlasModules = "$sysDrive\Windows\AtlasModules" Write-Host "Atlas Modules: $atlasModules" ``` -------------------------------- ### Import registry file Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Imports settings from a specified .reg file into the Windows registry. ```yaml - !regImport: {path: 'default.reg'} ``` -------------------------------- ### Invoke-AllDebloatOptimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Executes all debloating functions in sequence to apply comprehensive system optimizations. ```APIDOC ## Invoke-AllDebloatOptimizations ### Description Executes all debloating functions in sequence. This is the master function that runs all individual debloat optimizations with console output. ### Signature `Invoke-AllDebloatOptimizations()` ### Parameters - None ### Return Type - void ### Usage Example ```powershell Invoke-AllDebloatOptimizations ``` ``` -------------------------------- ### Initialize PowerShell Environment Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Configures the module search path to include Atlas-specific modules. This must be executed before calling any Atlas module functions. ```powershell # Add Atlas' PowerShell modules to module path $windir = [Environment]::GetFolderPath('Windows') $env:PSModulePath += ";$windir\AtlasModules\Scripts\Modules" ``` ```powershell # Run at beginning of any script using Atlas modules & "$windir\AtlasModules\initPowerShell.ps1" # Now can import and use module functions Import-Module Themes Set-Theme -Path "$env:windir\Resources\Themes\atlas-v0.4.x-dark.theme" ``` -------------------------------- ### Define Custom User Settings Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Template for user-specific configurations located in custom.yml. ```yaml --- title: Custom Settings description: User-configurable options actions: - !writeStatus: {status: 'Applying custom settings'} # User choices implemented here ``` -------------------------------- ### Execute command-line command Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Runs a system command with configurable execution context and wait behavior. ```yaml - !cmd: command: 'reg import settings.reg' exeDir: true wait: true runas: currentUserElevated ``` -------------------------------- ### Multi-User Configuration Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/README.md Iterate through user registry hives to apply settings across multiple user profiles. ```powershell # Apply settings to all users $userHives = Get-RegUserPaths -NoDefault foreach ($hive in $userHives) { # Modify registry for each user } ``` -------------------------------- ### Show full context menu Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Prevents Windows from showing the simplified context menu on the first click. ```powershell function Show-FullContextMenuOnItems ``` -------------------------------- ### Import Atlas Module Pattern Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Standard function used to initialize the environment and import specific Atlas PowerShell modules. ```powershell function Import-AtlasModule { param([string]$ModuleName) $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" Import-Module $ModuleName -ErrorAction Stop } ``` -------------------------------- ### Show-MoreDetailsOnTransfers Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Enables detailed progress display during file transfers by setting the EnthusiastMode registry value. ```APIDOC ## Show-MoreDetailsOnTransfers ### Description Shows more detailed information during copy, move, or delete operations instead of a simple progress bar. ### Registry Key - **Key**: HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\OperationStatusManager - **Value**: EnthusiastMode - **Data**: 1 ``` -------------------------------- ### Show-AllFilesWithExtensions Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Enables the display of hidden files and forces file extensions to be shown in Explorer. ```powershell function Show-AllFilesWithExtensions ``` -------------------------------- ### Retrieve Current User Desktop Path Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Fetches the desktop path for the current user session. ```powershell $desktopPath = Get-UserPath Write-Host "Desktop: $desktopPath" # Output: Desktop: C:\Users\Username\Desktop ``` -------------------------------- ### Invoke-AllPerformanceOptimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/performance-module.md Executes all performance optimization functions in sequence, providing a single-point entry for applying all performance tweaks. ```APIDOC ## Invoke-AllPerformanceOptimizations ### Description Executes all performance optimization functions in sequence. This is a master function that runs all individual optimization functions in a predefined order with progress messages. ### Signature `Invoke-AllPerformanceOptimizations` ### Parameters - None ### Return Type void ### Usage Example ```powershell Invoke-AllPerformanceOptimizations ``` ``` -------------------------------- ### Apply Atlas Theme Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Applies the Atlas dark theme and configures lockscreen settings. ```powershell function Set-AtlasTheme ``` -------------------------------- ### ThemeManagerClass Implementation Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md COM class implementation for theme management, marked as creatable. ```csharp [TypeLibType(TypeLibTypeFlags.FCanCreate)] [Guid("C04B329E-5823-4415-9C93-BA44688947B0")] [ClassInterface(ClassInterfaceType.None)] public class ThemeManagerClass : IThemeManager ``` -------------------------------- ### Enumerate All User Profiles Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Iterates through all discovered user registry hives and displays their names and paths. ```powershell $userHives = Get-RegUserPaths foreach ($hive in $userHives) { Write-Host "User: $($hive.Name)" Write-Host "Path: $($hive.PSPath)" } ``` -------------------------------- ### Define YAML Playbook Configuration Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Structure for playbook configuration files using custom YAML actions for system modifications. ```yaml --- title: Configuration Name description: What this configuration does actions: - !writeStatus: {status: 'Status message'} - !cmd: command: 'command to run' exeDir: true wait: true runas: currentUserElevated - !powerShell: command: 'powershell command' exeDir: true onUpgrade: true wait: true runas: currentUserElevated ``` -------------------------------- ### Component Management via DISM Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Commands for listing, disabling, and enabling Windows features using the Deployment Image Servicing and Management tool. ```cmd dism /Online /Get-Features /Format:Table dism /Online /Disable-Feature /FeatureName:NetFx3 dism /Online /Enable-Feature /FeatureName:NetFx3 ``` -------------------------------- ### Define New-Shortcut function Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Defines the parameters for creating a Windows shortcut, including mandatory source and destination paths. ```powershell function New-Shortcut { [CmdletBinding()] param ( [Parameter(Mandatory = $True)][ValidateNotNullOrEmpty()][string]$Source, [Parameter(Mandatory = $True)][ValidateNotNullOrEmpty()][string]$Destination, [ValidateNotNullOrEmpty()][string]$WorkingDir, [ValidateNotNullOrEmpty()][string]$Arguments, [ValidateNotNullOrEmpty()][string]$Icon, [switch]$IfExist ) } ``` -------------------------------- ### Restore Registry and Services Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Script to rebuild performance counters and reconfigure time services after registry cleanup. ```powershell # After removing malware or corrupted registry entries $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" Import-Module Miscellaneous # Rebuild performance counters Reset-PerformanceCounters # Reconfigure time services Set-TimeServers Write-Host "Registry and services restored" ``` -------------------------------- ### Configure Storage Sense Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Enables Storage Sense with aggressive cleanup settings and triggers the SilentCleanup task. ```powershell function Set-StorageSense ``` -------------------------------- ### Usage of Set-TimeServers Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Executes the function to configure NTP and verify the status. ```powershell # Configure NTP for accurate timekeeping Set-TimeServers # Verify with w32tm /query /status ``` -------------------------------- ### Restore-OldContextMenu Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Restores classic context menu behavior in Windows 11. ```powershell function Restore-OldContextMenu ``` -------------------------------- ### Custom Atlas Script Template Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/entry-points.md Standard boilerplate for creating custom administrative scripts, including environment initialization and pause functionality. ```powershell #Requires -RunAsAdministrator $windir = [Environment]::GetFolderPath('Windows') & "$windir\AtlasModules\initPowerShell.ps1" # Import needed modules Import-Module Utils Import-Module Themes # Use module functions Write-Title "Applying Atlas Configuration" # Your logic here Read-Pause "Configuration complete. Press Enter to exit." exit ``` -------------------------------- ### Set-FileExplorerToThisPC Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Sets File Explorer to open to 'This PC' instead of 'Quick Access'. ```APIDOC ## Set-FileExplorerToThisPC ### Description Changes the default File Explorer view from cloud-focused Quick Access to This PC. ### Registry Key - **Key**: HKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Advanced - **Value**: LaunchTo - **Data**: 1 ``` -------------------------------- ### Set-StorageSense Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Configures Storage Sense settings to manage temporary files and disk cleanup. ```APIDOC ## Set-StorageSense ### Description Configures Storage Sense policies for automated disk cleanup. ### Usage ```powershell & "$windir\AtlasModules\initPowerShell.ps1" Set-StorageSense ``` ``` -------------------------------- ### Define SHGetKnownFolderPath P/Invoke Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Imports the Windows Shell API function for retrieving known folder paths via COM interop. ```csharp [DllImport("shell32.dll", CharSet = CharSet.Unicode)] public static extern int SHGetKnownFolderPath( [MarshalAs(UnmanagedType.LPStruct)] Guid rfid, uint dwFlags, IntPtr hToken, out IntPtr pszPath ); ``` -------------------------------- ### Apply Settings to All Except System Accounts Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Uses Get-RegUserPaths to retrieve user hives while automatically excluding system accounts. ```powershell # Automatically excludes system accounts via DontCheckEnv = $false $userHives = Get-RegUserPaths # Now safe to modify user-specific settings foreach ($hive in $userHives) { # Settings applied only to real user profiles } ``` -------------------------------- ### Invoke-AllPrivacyOptimizations Usage Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Executes the full suite of privacy optimizations. ```powershell Invoke-AllPrivacyOptimizations ``` -------------------------------- ### Terminate processes by path Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/utils-module.md Defines the Stop-ProcessesUnderRoots function and demonstrates terminating processes from specific directories. ```powershell function Stop-ProcessesUnderRoots { param([string[]]$RootsLower) } ``` ```powershell $roots = @('c:\windows\temp', 'c:\bloatware\') Stop-ProcessesUnderRoots -RootsLower $roots ``` -------------------------------- ### Create a shortcut conditionally Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/shortcuts-module.md Uses the IfExist parameter to ensure the shortcut is only created if the destination path already exists. ```powershell # Replace existing shortcut, but don't create a new one New-Shortcut -Source "C:\Program Files\App\app.exe" ` -Destination "$env:USERPROFILE\Desktop\App.lnk" ` -IfExist ``` -------------------------------- ### Get-SystemDrive Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the system drive letter by checking environment variables, WMI queries, and a default fallback. ```APIDOC ## Get-SystemDrive ### Description Retrieves the system drive (e.g., C:) by checking the $env:SystemDrive environment variable, querying WMI, or defaulting to C: if other methods fail. ### Returns - **String**: The drive letter path (e.g., "C:") ### Errors - **Failed to find the system drive!**: Returned if no drive can be identified. ``` -------------------------------- ### Define Invoke-AllDebloatOptimizations Function Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Function definition for the master debloat optimization entry point. ```powershell function Invoke-AllDebloatOptimizations ``` -------------------------------- ### Define MsgButtons enumeration Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/utils-module.md Defines the available button configurations for message box displays. ```powershell enum MsgButtons { Ok OkCancel AbortRetryIgnore YesNoCancel YesNo RetryAndCancel } ``` -------------------------------- ### Validation Process Logic Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Describes the steps taken to verify user hives when DontCheckEnv is false. ```text 1. Get all child items from HKU matching SID pattern 2. For each item, check if it has Volatile Environment subkey 3. Only include items with this verification key 4. Exclude orphaned SIDs and system accounts ``` -------------------------------- ### Enable-CompactMode Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Reduces row height and spacing in Explorer views for a more compact display. ```powershell function Enable-CompactMode ``` -------------------------------- ### Write-Title Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/utils-module.md Displays a formatted title with dash separators to highlight sections in console output. ```APIDOC ## Write-Title ### Description Displays a formatted title with dash separators to highlight sections in console output. The text is centered between lines of dashes and displayed in yellow. ### Parameters - **Text** (string) - Required - Title text to display with decorative dashes ### Usage Example ```powershell Write-Title "Configuring System Settings" ``` ``` -------------------------------- ### Execute Invoke-AllMiscSystemUtilities Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Runs the master utility function to execute all miscellaneous system tasks in the defined sequence. ```powershell Invoke-AllMiscSystemUtilities ``` -------------------------------- ### Integrate Get-UserPath with Utils Module Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the documents folder path using a specific FolderID to create a shortcut. ```powershell # Create shortcut in user's documents $documentsPath = Get-UserPath -FolderID 'FDD39AD0-238F-46AF-ADB4-6C85480369C7' New-Shortcut -Source "powershell.exe" ` -Destination "$documentsPath\PowerShell.lnk" ``` -------------------------------- ### Set lockscreen image Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Sets the system lockscreen image using either the default Atlas path or a custom file path. ```powershell # Use default Atlas lockscreen Set-LockscreenImage # Use custom image Set-LockscreenImage -Path "C:\custom-lockscreen.png" ``` -------------------------------- ### AtlasOS Source Directory Structure Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/INDEX.md Visual representation of the project's file hierarchy, highlighting the location of PowerShell modules, configuration files, and core scripts. ```text atlas/ ├── src/ │ └── playbook/ │ ├── Executables/ │ │ ├── AtlasModules/ │ │ │ ├── Scripts/ │ │ │ │ ├── Modules/ [All .psm1 module files] │ │ │ │ ├── initPowerShell.ps1 │ │ │ │ ├── newUsers.ps1 │ │ │ │ └── ScriptWrappers/ │ │ │ ├── Tools/ │ │ │ └── Wallpapers/ │ │ └── AtlasDesktop/ [UI scripts] │ └── Configuration/ │ ├── atlas/ [Core configs] │ ├── tweaks/ [Optional tweaks] │ └── custom.yml [User customization] ├── README.md [Project README] └── LICENSE [GPLv3] ``` -------------------------------- ### Display status message Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Updates the user interface with a progress message during playbook execution. ```yaml - !writeStatus: {status: 'Applying Atlas configuration'} ``` -------------------------------- ### Enable detailed transfer progress Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Enables detailed progress display during file operations instead of the default simple progress bar. ```powershell function Show-MoreDetailsOnTransfers ``` -------------------------------- ### Configure Send To context menu Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Removes commonly unused items like Documents, Mail, Fax, and Bluetooth from the Send To context menu. ```powershell function Set-SendToContextMenu ``` -------------------------------- ### !powerShell Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Executes a PowerShell script or command. ```APIDOC ## !powerShell ### Description Execute PowerShell script or command. ### Parameters - **command** (string) - Required - PowerShell command or script - **exeDir** (bool) - Optional - Use playbook directory (Default: false) - **onUpgrade** (bool) - Optional - Run on Windows upgrade (Default: false) - **wait** (bool) - Optional - Wait for completion (Default: false) - **runas** (enum) - Optional - Execution level: currentUser, currentUserElevated, system (Default: currentUser) - **noExit** (bool) - Optional - Keep window open (Default: false) ### Example - !powerShell: command: '.\\setup.ps1' exeDir: true onUpgrade: true wait: true runas: currentUserElevated ``` -------------------------------- ### Set File Explorer to This PC Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Changes the default File Explorer view from Quick Access to This PC. ```powershell function Set-FileExplorerToThisPC ``` -------------------------------- ### Perform Multi-User Registry Operations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/README.md Iterate through user registry hives to apply system settings across multiple user profiles. ```powershell $userHives = Get-RegUserPaths -NoDefault foreach ($hive in $userHives) { # Apply settings to each user } ``` -------------------------------- ### !appxRemove Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Removes a UWP application by package name or pattern. ```APIDOC ## !appxRemove ### Description Remove UWP application by package name. ### Parameters - **package** (string) - Required - App package GUID or pattern ### Example - !appxRemove: {package: 'Microsoft.Cortana_*'} ``` -------------------------------- ### Configure NTP Servers via w32tm Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Commands used to update the Windows Time Service configuration with public NTP pool servers. ```powershell w32tm /config /syncfromflags:manual /manualpeerlist:"0.pool.ntp.org 1.pool.ntp.org 2.pool.ntp.org 3.pool.ntp.org" w32tm /config /update w32tm /resync ``` -------------------------------- ### !regImport Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Imports a registry file in .reg format. ```APIDOC ## !regImport ### Description Import registry file (.reg format). ### Parameters - **path** (string) - Required - Registry file path ### Example - !regImport: {path: 'default.reg'} ``` -------------------------------- ### Disable-TailoredExperiences Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Disables personalized recommendations based on diagnostic data collection. ```powershell function Disable-TailoredExperiences ``` -------------------------------- ### Apply theme and update MRU Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Updates the Theme Most Recently Used registry list after applying a theme. ```powershell # Apply theme and update MRU Set-Theme -Path "$env:windir\Resources\Themes\atlas-v0.5.x-dark.theme" Set-ThemeMRU ``` -------------------------------- ### Get-RegUserPaths Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Retrieves registry paths for all user profiles loaded in HKU (HKEY_USERS). ```APIDOC ## Get-RegUserPaths ### Description Retrieves registry paths for all user profiles loaded in HKU (HKEY_USERS). This function enumerates currently loaded user profiles and filters out system/built-in accounts by default. ### Parameters #### Optional Parameters - **DontCheckEnv** (switch) - Skip verification that user hive has Volatile Environment key. - **NoDefault** (switch) - Exclude default user profile from results. ### Return Value Returns an array of PowerShell RegistryKey objects representing user hives in HKU. Each object contains properties such as PSPath, Name, SubKeyCount, and ValueCount. ``` -------------------------------- ### Remove UWP Applications Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/configuration-reference.md Syntax for removing specific UWP packages using the !appxRemove action. ```yaml - !appxRemove: {package: 'Microsoft.Cortana_*'} ``` -------------------------------- ### Set-SendToContextMenu Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Configures the 'Send To' context menu to remove clutter by disabling unused items. ```APIDOC ## Set-SendToContextMenu ### Description Removes commonly unused items from the 'Send To' context menu by disabling them. ### Disabled Items - Documents - Mail Recipient - Fax recipient - Bluetooth ``` -------------------------------- ### Define Set-LockscreenImage function Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Defines the Set-LockscreenImage function signature with a default path parameter. ```powershell function Set-LockscreenImage { param ( [ValidateNotNullOrEmpty()] [string]$Path = "$([Environment]::GetFolderPath('Windows'))\AtlasModules\Wallpapers\lockscreen_dark.png" ) } ``` -------------------------------- ### Integrate Get-UserPath with Scripts Module Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/userpaths-module.md Retrieves the local AppData path to ensure a scripts directory exists. ```powershell # Store scripts in local AppData $appDataPath = Get-UserPath -FolderID 'F1B32785-6FBA-4FCF-9D55-7B8E7F157091' $scriptFolder = "$appDataPath\Scripts" if (!(Test-Path $scriptFolder)) { New-Item -ItemType Directory -Path $scriptFolder | Out-Null } ``` -------------------------------- ### Set-AtlasTheme Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Applies the default Atlas dark theme and configures lockscreen settings. ```APIDOC ## Set-AtlasTheme ### Description Applies the Atlas dark theme and configures lockscreen settings. Disables rotating lockscreen and sets default theme policy. ### Signature `Set-AtlasTheme` ### Return Type void ``` -------------------------------- ### Rebuild Performance Counters Commands Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Commands executed to reset the performance counter library and resynchronize WMI. ```powershell lodctr /r # Load counters (run twice) lodctr /r winmgmt /resyncperf # Resync WMI performance library ``` -------------------------------- ### Invoke-AllPrivacyOptimizations Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/privacy-module.md Executes all privacy-focused optimization functions in sequence to apply comprehensive privacy settings. ```APIDOC ## Invoke-AllPrivacyOptimizations ### Description Executes all individual privacy optimization functions in sequence. This is the master function for applying comprehensive privacy settings across the system. ### Signature `Invoke-AllPrivacyOptimizations` ### Parameters - None ### Return Type void ### Usage Example ```powershell Invoke-AllPrivacyOptimizations ``` ``` -------------------------------- ### Get-RegUserPaths Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/allregistryusers-module.md Retrieves a list of registry user profiles based on SID patterns and environment validation. ```APIDOC ## Get-RegUserPaths ### Description Retrieves registry paths for user profiles. It identifies profiles based on SID patterns and optionally validates the existence of a Volatile Environment key. ### Parameters - **DontCheckEnv** (Switch) - Optional - When enabled, includes all registry keys matching the SID pattern without verifying the Volatile Environment key exists. - **NoDefault** (Switch) - Optional - When enabled, excludes the default user profile from the results. ### Usage Example ```powershell $userHives = Get-RegUserPaths -NoDefault -DontCheckEnv foreach ($hive in $userHives) { Write-Host "User: $($hive.Name)" } ``` ``` -------------------------------- ### Apply Specific Debloating Tasks Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/debloat-module.md Executes targeted debloating functions to disable content delivery and configure storage settings individually. ```powershell # Import the module & "$windir\AtlasModules\initPowerShell.ps1" # Disable only content delivery Set-ContentDelivery # Configure storage sense but keep reserved storage Set-StorageSense ``` -------------------------------- ### Access Quick Access Pins Registry Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/miscellaneous-module.md Registry paths where Quick Access pins are stored. ```text HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\FavoritesSortOrder HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\PanelFavoriteSortOrder ``` -------------------------------- ### Display formatted console title Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/utils-module.md Defines the Write-Title function structure and demonstrates its usage for section headers. ```powershell function Write-Title { param ( [Parameter(Mandatory = $true)] [string]$Text ) } ``` ```powershell Write-Title "Configuring System Settings" # Output: # --------------------------------- # Configuring System Settings # --------------------------------- ``` -------------------------------- ### Set-TooltipColorBlue Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Changes the system tooltip background color to blue. ```APIDOC ## Set-TooltipColorBlue ### Description Changes the tooltip color from default to blue by modifying the InfoWindow color in Control Panel Colors. ### Signature `Set-TooltipColorBlue` ### Return Type void ``` -------------------------------- ### Disable-SharedExperiences Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/qol-module.md Disables cloud device synchronization and Bluetooth nearby sharing features. ```powershell function Disable-SharedExperiences ``` -------------------------------- ### Define Set-Theme function Source: https://github.com/atlas-os/atlas/blob/main/_autodocs/themes-module.md Defines the Set-Theme function signature for applying Windows theme files. ```powershell function Set-Theme { param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string]$Path ) } ```