{"id":13599413,"url":"https://github.com/NotNotWrongUsually/OutConsolePicture","last_synced_at":"2025-04-10T12:32:39.688Z","repository":{"id":43369522,"uuid":"175597923","full_name":"NotNotWrongUsually/OutConsolePicture","owner":"NotNotWrongUsually","description":"Powershell cmdlet for rendering image files to console","archived":false,"fork":false,"pushed_at":"2023-03-19T20:11:07.000Z","size":24,"stargazers_count":31,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-11-07T00:42:38.537Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NotNotWrongUsually.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-03-14T10:18:02.000Z","updated_at":"2024-08-12T23:08:04.000Z","dependencies_parsed_at":"2024-11-07T00:34:45.085Z","dependency_job_id":null,"html_url":"https://github.com/NotNotWrongUsually/OutConsolePicture","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNotWrongUsually%2FOutConsolePicture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNotWrongUsually%2FOutConsolePicture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNotWrongUsually%2FOutConsolePicture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NotNotWrongUsually%2FOutConsolePicture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NotNotWrongUsually","download_url":"https://codeload.github.com/NotNotWrongUsually/OutConsolePicture/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217145,"owners_count":21066633,"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-01T17:01:03.734Z","updated_at":"2025-04-10T12:32:34.652Z","avatar_url":"https://github.com/NotNotWrongUsually.png","language":"PowerShell","readme":"# OutConsolePicture\nPowershell cmdlet for rendering image files to console\n\n# How to install?\nThe module is published to the Powershell Gallery, so get it from there with `Install-Module -Name OutConsolePicture`\n\n# Result\n![Dandelion](https://i.imgur.com/80gucpA.png)\n\n# Documentation\n\nStraight from the module help:\n\n```\nNAME\n    Out-ConsolePicture\n\nSYNOPSIS\n    Renders an image to the console\n\n\nSYNTAX\n    Out-ConsolePicture [-Path] \u003cString[]\u003e [-Width \u003cInt32\u003e] [-TransparencyColor \u003cColor\u003e] [-HorizontalPosition \u003cString\u003e] [-DoNotResize] [\u003cCommonParameters\u003e]\n\n    Out-ConsolePicture -Url \u003cUri[]\u003e [-Width \u003cInt32\u003e] [-TransparencyColor \u003cColor\u003e] [-HorizontalPosition \u003cString\u003e] [-DoNotResize] [\u003cCommonParameters\u003e]\n\n    Out-ConsolePicture -InputObject \u003cBitmap[]\u003e [-Width \u003cInt32\u003e] [-TransparencyColor \u003cColor\u003e] [-HorizontalPosition \u003cString\u003e] [-DoNotResize] [\u003cCommonParameters\u003e]\n\n\nDESCRIPTION\n    Out-ConsolePicture will take an image file and convert it to a text string. Colors will be \"encoded\" using ANSI escape strings. The final result will be output in the shell. By\n    default images will be reformatted to the size of the current shell, though this behaviour can be suppressed with the -DoNotResize switch. ISE users, take note: ISE does not report\n    a window width, and scaling fails as a result. I don't think there is anything I can do about that, so either use the -DoNotResize switch, or don't use ISE.\n\n\nPARAMETERS\n    -Path \u003cString[]\u003e\n        One or more paths to the image(s) to be rendered to the console.\n\n        Required?                    true\n        Position?                    1\n        Default value\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    -Url \u003cUri[]\u003e\n        One or more Urls for the image(s) to be rendered to the console.\n\n        Required?                    true\n        Position?                    named\n        Default value\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    -InputObject \u003cBitmap[]\u003e\n        A Bitmap object that will be rendered to the console.\n\n        Required?                    true\n        Position?                    named\n        Default value\n        Accept pipeline input?       true (ByValue)\n        Accept wildcard characters?  false\n\n    -Width \u003cInt32\u003e\n        Renders the image at this specific width. Use of the width parameter overrides DoNotResize.\n\n        Required?                    false\n        Position?                    named\n        Default value                0\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    -TransparencyColor \u003cColor\u003e\n        If the image is transparent this is the color that will be used for transparency. The parameter needs a color object. Check examples for how to set it. This should be the same\n        color as your console background usually.\n\n        Required?                    false\n        Position?                    named\n        Default value\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    -HorizontalPosition \u003cString\u003e\n        Takes the values \"Left\", \"Center\", or \"Right\" and renders the image in that position.\n\n        Required?                    false\n        Position?                    named\n        Default value\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    -DoNotResize [\u003cSwitchParameter\u003e]\n        By default, images will be resized to have their width match the current console width. Setting this switch disables that behaviour.\n\n        Required?                    false\n        Position?                    named\n        Default value                False\n        Accept pipeline input?       false\n        Accept wildcard characters?  false\n\n    \u003cCommonParameters\u003e\n        This cmdlet supports the common parameters: Verbose, Debug,\n        ErrorAction, ErrorVariable, WarningAction, WarningVariable,\n        OutBuffer, PipelineVariable, and OutVariable. For more information, see\n        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).\n\nINPUTS\n    One or more System.Drawing.Bitmap objects\n\n\nOUTPUTS\n    Gloriously coloured console output\n\n\n    -------------------------- EXAMPLE 1 --------------------------\n\n    PS \u003e Out-ConsolePicture \".\\someimage.jpg\"\n    Renders the image to console\n\n\n\n\n\n\n    -------------------------- EXAMPLE 2 --------------------------\n\n    PS \u003e Out-ConsolePicture -Url \"http://somewhere.com/image.jpg\"\n    Renders the image to console\n\n\n\n\n\n\n    -------------------------- EXAMPLE 3 --------------------------\n\n    PS \u003e $image = New-Object System.Drawing.Bitmap -ArgumentList \"C:\\myimages\\image.png\"\n    $image | Out-ConsolePicture\n    Creates a new Bitmap object from a file on disk renders it to the console\n\n\n\n\n\n\n    -------------------------- EXAMPLE 4 --------------------------\n\n    PS \u003e Out-ConsolePicture \".\\someimage.jpg\" -TransparencyColor ([System.Drawing.Color]::FromArgb(40, 44, 52))\n    Renders a transparent image using the specified color for transparency.\n\n\n\n\n\n\n\nRELATED LINKS\n```\n\n# License\nYou can copy it, change it, or stick it in your hat;\nBut never charge a penny for it - simple as that!","funding_links":[],"categories":["PowerShell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNotNotWrongUsually%2FOutConsolePicture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNotNotWrongUsually%2FOutConsolePicture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNotNotWrongUsually%2FOutConsolePicture/lists"}