{"id":16471804,"url":"https://github.com/theboeffect/s3-unzip","last_synced_at":"2026-06-09T02:03:56.819Z","repository":{"id":119956157,"uuid":"397299229","full_name":"theBoEffect/s3-unzip","owner":"theBoEffect","description":"An updated to the s3-unzip library by Steve Yardumian to allow gz formats.","archived":false,"fork":false,"pushed_at":"2021-08-19T20:01:37.000Z","size":142,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-28T10:09:06.946Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theBoEffect.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-08-17T15:06:59.000Z","updated_at":"2021-08-19T20:01:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"f35b3575-f51d-42cb-b043-2c41b2bcd55b","html_url":"https://github.com/theBoEffect/s3-unzip","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/theBoEffect/s3-unzip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fs3-unzip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fs3-unzip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fs3-unzip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fs3-unzip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theBoEffect","download_url":"https://codeload.github.com/theBoEffect/s3-unzip/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theBoEffect%2Fs3-unzip/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34088014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-10-11T12:14:45.345Z","updated_at":"2026-06-09T02:03:56.791Z","avatar_url":"https://github.com/theBoEffect.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# S3 Unzip2\n\nThis is a fork of [S3 Unzip](https://bitbucket.org/copperhill/s3-unzip.git) by Steve Yardumian updated to support gz files. Note, gz not tar.gaz, so its assumed to be a single named compressed file, not a bunch of combined files in a tar that is then compressed. I may add tar support later.\n\n## S3 Unzip ##\n\nA simple library to unzip an archive file in a S3 bucket to its root folder.\n\n### Install ###\n\n- To include as library: `npm install s3-unzip`\n- To use as a command-line tool: `npm install -g s3-unzip`\n\n### Restrictions ###\n\n- The module only supports the input zip file MIME type of 'application/zip'.\n\n### Command Line Usage ###\n\n`s3-unzip [-dv] \u003cbucket name\u003e \u003cfilename\u003e`\n\n#### Required ####\n\n- `\u003cbucket name\u003e` : Bucket name in S3 where the zip file exists\n- `\u003cfilename\u003e` : Filename (including the .zip extension) of the archive that will be decompressed\n\n#### Options ####\n\n- `-d, --delete-on-success` : Delete the zip file once the decompression has finished\n- `-v, --verbose` : Show the console log messages during runtime\n\n#### Example ####\n\n`s3-unzip -d -v test-bucket-in-s3 Companies.zip`\n\n### Library Usage ###\n\nInclude like most libraries:\n\n`var s3Unzip = require(\"s3-unzip\");`\n\nRun the decompression for the file in the specified bucket:\n\n#### Options ####\n\n~~~~\nvar s = new s3Unzip({\n    bucket: \"test-bucket-in-s3\",\n    file: \"Companies.zip\",\n    deleteOnSuccess: true,\n    verbose: false\n  }, function(err, success){\n    if (err) console.error(err);\n    else console.log(success);\n  });\n~~~~\n\n### AWS Lambda Usage ###\n\nCreate an AWS Lambda function, name it, and zip all files from this package to upload the code (including node_modules). The function defaults to deleting the zip file after it's been decompressed and verbose messages logged to CloudWatch.\n\n#### Configuration ####\n\n##### Basic #####\n- Runtime: **Node.js 6.10**\n- Handler: **index.handler**\n- Role: **(create a custom role with Full S3 Access)**\n\n##### Advanced #####\n\nFor a 20MB zip file:\n- Memory: **at least 512MB**\n- Timeout: **at least 30 sec**\n\n#### Options ####\n\nTest JSON:\n~~~~\n{\n  \"event\":{\n    \"Records\": [\n      {\n        \"s3\": {\n          \"bucket\": {\n            \"name\": \"test-bucket-in-s3\"\n          },\n          \"object\": {\n            \"key\": \"Companies.zip\"\n          }\n        }\n      }\n    ]\n  }\n}\n~~~~\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheboeffect%2Fs3-unzip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheboeffect%2Fs3-unzip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheboeffect%2Fs3-unzip/lists"}