{"id":14063824,"url":"https://github.com/DBremen/Write-TerminalProgress","last_synced_at":"2025-07-29T16:34:14.846Z","repository":{"id":90452321,"uuid":"351793397","full_name":"DBremen/Write-TerminalProgress","owner":"DBremen","description":"PowerShell function to indicate progress, using cli-spinner icons, during longer running tasks.","archived":false,"fork":false,"pushed_at":"2021-03-31T07:04:59.000Z","size":10,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-13T07:05:33.066Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DBremen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-26T13:35:49.000Z","updated_at":"2024-05-26T06:10:07.000Z","dependencies_parsed_at":null,"dependency_job_id":"d13fda35-aae4-417e-be4c-84854579976c","html_url":"https://github.com/DBremen/Write-TerminalProgress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DBremen%2FWrite-TerminalProgress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DBremen%2FWrite-TerminalProgress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DBremen%2FWrite-TerminalProgress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DBremen%2FWrite-TerminalProgress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DBremen","download_url":"https://codeload.github.com/DBremen/Write-TerminalProgress/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228032909,"owners_count":17858913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-13T07:03:31.607Z","updated_at":"2024-12-04T02:30:29.098Z","avatar_url":"https://github.com/DBremen.png","language":"PowerShell","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"readme":"# Write-TerminalProgress\n\nPowerShell terminal spinner progress cmdlet. See related [blog post](https://powershellone.wordpress.com/?p=1506.)\n\n## SYNOPSIS\nPowerShell function to indicate progress, using cli-spinner icons, during longer running tasks.\n\n## SYNTAX\n\n```\nWrite-TerminalProgress [-InputObject] \u003cObject\u003e [-IconSet] \u003cObject\u003e [[-Begin] \u003cScriptBlock\u003e]\n [-Process] \u003cScriptBlock\u003e [[-End] \u003cScriptBlock\u003e] [[-Activity] \u003cString\u003e] [[-CurrentStatus] \u003cString\u003e]\n [-ReturnFullOutput]\n```\n\n## DESCRIPTION\nThe function utilizes ANSI Escape sequences the build a simple TUI that shows progress using cli-spinners.\nThe function works similar to foreach-object in many other aspects.\n\n## EXAMPLES\n\n### -------------------------- EXAMPLE 1 --------------------------\n```\n$htArgs = @{\n```\n\nIconSet = 'fistBump'\n    Process = { \"Doing $_\";sleep -Seconds 2 }\n    Activity = 'Working hard'\n    CurrentStatus = 'Status _'\n}\n1..5 | Write-TerminalProgress @htArgs\n\n## PARAMETERS\n\n### -InputObject\nSpecifies the input objects.\nThe function runs the script block or operation statement on each input object.\nThe argument to this parameter is usually provided by pipeline.\n\n```yaml\nType: Object\nParameter Sets: (All)\nAliases: \n\nRequired: True\nPosition: 1\nDefault value: None\nAccept pipeline input: True (ByValue)\nAccept wildcard characters: False\n```\n\n### -IconSet\nThe IconSet to be used for the spinner.\n\n```yaml\nType: Object\nParameter Sets: (All)\nAliases: \n\nRequired: True\nPosition: 2\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -Begin\nSpecifies a script block that runs before this cmdlet processes any input objects.\n\n```yaml\nType: ScriptBlock\nParameter Sets: (All)\nAliases: \n\nRequired: False\nPosition: 3\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -Process\nSpecifies the operation that is performed on each input object. \nThis script block is run for every object in the pipeline.\n\n```yaml\nType: ScriptBlock\nParameter Sets: (All)\nAliases: \n\nRequired: True\nPosition: 4\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -End\nSpecifies a script block that runs after this cmdlet processes all input objects. \nThis script block is only run once for the entire pipeline.\n\n```yaml\nType: ScriptBlock\nParameter Sets: (All)\nAliases: \n\nRequired: False\nPosition: 5\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -Activity\nA static message that describes the process.\n\n```yaml\nType: String\nParameter Sets: (All)\nAliases: \n\nRequired: False\nPosition: 6\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -CurrentStatus\nProgress output for each iteration of the process block.\n\"_\" can be used to refer to the current object.\n\n```yaml\nType: String\nParameter Sets: (All)\nAliases: \n\nRequired: False\nPosition: 7\nDefault value: None\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n### -ReturnFullOutput\n{{Fill ReturnFullOutput Description}}\n\n```yaml\nType: SwitchParameter\nParameter Sets: (All)\nAliases: \n\nRequired: False\nPosition: Named\nDefault value: False\nAccept pipeline input: False\nAccept wildcard characters: False\n```\n\n## INPUTS\n\n## OUTPUTS\n\n## NOTES\n\n## RELATED LINKS\n\n[https://github.com/sindresorhus/cli-spinners](https://github.com/sindresorhus/cli-spinners)\n\n[]()\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDBremen%2FWrite-TerminalProgress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDBremen%2FWrite-TerminalProgress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDBremen%2FWrite-TerminalProgress/lists"}