{"id":18148691,"url":"https://github.com/doggy8088/file-encoder","last_synced_at":"2025-06-17T06:07:26.913Z","repository":{"id":225428322,"uuid":"765975385","full_name":"doggy8088/file-encoder","owner":"doggy8088","description":"This script helps people encode/decode any file to/from a byte-array encoded plain text file.","archived":false,"fork":false,"pushed_at":"2024-03-02T02:20:03.000Z","size":4,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-15T13:04:33.245Z","etag":null,"topics":["powershell","powershell-gallery","powershell-module","powershell-scripts"],"latest_commit_sha":null,"homepage":"https://www.powershellgallery.com/packages/file-encoder/","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/doggy8088.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2024-03-02T02:10:49.000Z","updated_at":"2024-03-02T02:12:16.000Z","dependencies_parsed_at":"2024-03-02T03:24:20.855Z","dependency_job_id":"1204c666-02cc-4c4e-8ba2-3a81faa4ef72","html_url":"https://github.com/doggy8088/file-encoder","commit_stats":null,"previous_names":["doggy8088/file-encoder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/doggy8088/file-encoder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doggy8088%2Ffile-encoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doggy8088%2Ffile-encoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doggy8088%2Ffile-encoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doggy8088%2Ffile-encoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doggy8088","download_url":"https://codeload.github.com/doggy8088/file-encoder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doggy8088%2Ffile-encoder/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260301993,"owners_count":22988722,"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":["powershell","powershell-gallery","powershell-module","powershell-scripts"],"created_at":"2024-11-01T23:09:41.700Z","updated_at":"2025-06-17T06:07:26.889Z","avatar_url":"https://github.com/doggy8088.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# file-encoder\n\nThis script helps people encode/decode any file to/from a byte-array encoded plain text file.\n\n## Install\n\nSimply install [file-encoder](https://www.powershellgallery.com/packages/file-encoder/) script from the PowerShell Gallery.\n\n```ps1\nInstall-Module -Name file-encoder\n```\n\n## Usage\n\n1. When encoding, no need to enter the `-SavePath` parameter, it will default to changing the file name from `a.zip` to `a.enc`\n\n    ```ps1\n    Encode-File .\\a.zip\n    Decode-File .\\a.enc .\\b.zip\n    ```\n\n2. When encoding, pass in the file to be read and the new file to be written\n\n    ```ps1\n    Encode-File .\\a.zip .\\a.txt\n    Decode-File .\\a.txt .\\b.zip\n    ```\n\n    \u003e The encoded file will always be a ASCII encoding plain text file.\n\n3. When encoding, pass in the file to be read and the new file to be written, but explicitly specify parameter names\n\n    ```ps1\n    Encode-File -FilePath .\\a.zip -SavePath .\\a.txt\n    Decode-File -FilePath .\\a.txt -SavePath .\\b.zip\n    ```\n\n## Publishing\n\n1. Validate the script using `Invoke-ScriptAnalyzer` cmdlet\n\n    ```ps1\n    Install-Module -Name PSScriptAnalyzer\n    ```\n\n    ```ps1\n    Invoke-ScriptAnalyzer -Path ./file-encoder.psm1\n    ```\n\n2. Test publishing for PowerShell Gallery\n\n    With the following command, you can test whether the module can be successfully published. The `-WhatIf` parameter here will not actually publish your module, but rather test if there are any issues during the publishing process.\n\n    ```ps1\n    Publish-Module `\n        -Path \"G:\\Projects\\linqpad-folders-powershell-module\\\" `\n        -NuGetApiKey $env:PowerShellGalleryApiKey `\n        -WhatIf `\n        -Verbose\n    ```\n\n3. Publish to PowerShell Gallery\n\n    Simply remove the `-WhatIf` parameter to perform the actual publishing operation.\n\n    ```ps1\n    Publish-Module `\n        -Path \"G:\\Projects\\linqpad-folders-powershell-module\\\" `\n        -NuGetApiKey $env:PowerShellGalleryApiKey `\n        -Verbose\n    ```\n\n    Finally, if you see the following message, it means the publishing was successful!\n\n    ```txt\n    VERBOSE: Successfully published module 'linqpad-folders-powershell-module' to the module publish location 'https://www.powershellgallery.com/api/v2/package/'. Please allow few minutes for 'linqpad-folders-powershell-module' to show up in the search results.\n    ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoggy8088%2Ffile-encoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoggy8088%2Ffile-encoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoggy8088%2Ffile-encoder/lists"}