{"id":19040763,"url":"https://github.com/cloudfoundry/bosh-s3cli","last_synced_at":"2025-04-07T17:07:40.789Z","repository":{"id":12044529,"uuid":"14630229","full_name":"cloudfoundry/bosh-s3cli","owner":"cloudfoundry","description":"Go CLI for S3","archived":false,"fork":false,"pushed_at":"2024-09-14T10:17:14.000Z","size":23894,"stargazers_count":36,"open_issues_count":1,"forks_count":25,"subscribers_count":22,"default_branch":"main","last_synced_at":"2024-09-14T20:40:59.034Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudfoundry.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":"2013-11-22T21:46:50.000Z","updated_at":"2024-09-14T10:06:09.000Z","dependencies_parsed_at":"2023-09-28T03:14:25.871Z","dependency_job_id":"af647584-76b3-4c6b-8fb1-534797f83d16","html_url":"https://github.com/cloudfoundry/bosh-s3cli","commit_stats":null,"previous_names":["pivotal-golang/s3cli"],"tags_count":306,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fbosh-s3cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fbosh-s3cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fbosh-s3cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry%2Fbosh-s3cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry","download_url":"https://codeload.github.com/cloudfoundry/bosh-s3cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694875,"owners_count":20980733,"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-11-08T22:24:57.745Z","updated_at":"2025-04-07T17:07:40.763Z","avatar_url":"https://github.com/cloudfoundry.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## S3 CLI\n\nA CLI for uploading, fetching and deleting content to/from an S3-compatible\nblobstore.\n\nContinuous integration: \u003chttps://bosh-cpi.ci.cf-app.com/pipelines/s3cli\u003e\n\nReleases can be found in `https://s3.amazonaws.com/bosh-s3cli-artifacts`. The Linux binaries follow the regex `s3cli-(\\d+\\.\\d+\\.\\d+)-linux-amd64` and the windows binaries `s3cli-(\\d+\\.\\d+\\.\\d+)-windows-amd64`.\n\n## Installation\n\n```\ngo get github.com/cloudfoundry/bosh-s3cli\n```\n\n## Usage\n\nGiven a JSON config file (`config.json`)...\n\n``` json\n{\n  \"bucket_name\":            \"\u003cstring\u003e (required)\",\n\n  \"credentials_source\":     \"\u003cstring\u003e [static|env_or_profile|none]\",\n  \"access_key_id\":          \"\u003cstring\u003e (required if credentials_source = 'static')\",\n  \"secret_access_key\":      \"\u003cstring\u003e (required if credentials_source = 'static')\",\n\n  \"region\":                 \"\u003cstring\u003e (optional - default: 'us-east-1')\",\n  \"host\":                   \"\u003cstring\u003e (optional)\",\n  \"port\":                   \u003cint\u003e (optional),\n\n  \"ssl_verify_peer\":        \u003cbool\u003e (optional),\n  \"use_ssl\":                \u003cbool\u003e (optional),\n  \"signature_version\":      \"\u003cstring\u003e (optional)\",\n  \"server_side_encryption\": \"\u003cstring\u003e (optional)\",\n  \"sse_kms_key_id\":         \"\u003cstring\u003e (optional)\",\n  \"multipart_upload\":       \u003cbool\u003e (optional - default: true)\n}\n```\n\n``` bash\n# Usage\ns3cli --help\n\n# Command: \"put\"\n# Upload a blob to an S3-compatible blobstore.\ns3cli -c config.json put \u003cpath/to/file\u003e \u003cremote-blob\u003e\n\n# Command: \"get\"\n# Fetch a blob from an S3-compatible blobstore.\n# Destination file will be overwritten if exists.\ns3cli -c config.json get \u003cremote-blob\u003e \u003cpath/to/file\u003e\n\n# Command: \"delete\"\n# Remove a blob from an S3-compatible blobstore.\ns3cli -c config.json delete \u003cremote-blob\u003e\n\n# Command: \"exists\"\n# Checks if blob exists in an S3-compatible blobstore.\ns3cli -c config.json exists \u003cremote-blob\u003e\n\n# Command: \"sign\"\n# Create a self-signed url for an object\ns3cli -c config.json sign \u003cremote-blob\u003e \u003cget|put\u003e \u003cseconds-to-expiration\u003e\n```\n\n## Contributing\n\nFollow these steps to make a contribution to the project:\n\n- Fork this repository\n- Create a feature branch based upon the `main` branch (*pull requests must be made against this branch*)\n  ``` bash\n  git checkout -b feature-name origin/main\n  ```\n- Run tests to check your development environment setup\n  ``` bash\n  scripts/ginkgo -r -race --skip-package=integration ./\n  ```\n- Make your changes (*be sure to add/update tests*)\n- Run tests to check your changes\n  ``` bash\n  scripts/ginkgo -r -race --skip-package=integration ./\n  ```\n- Push changes to your fork\n  ``` bash\n  git add .\n  git commit -m \"Commit message\"\n  git push origin feature-name\n  ```\n- Create a GitHub pull request, selecting `main` as the target branch\n\n## Running integration tests\n\nTo run the integration tests, export the following variables into your environment:\n\n```\nexport access_key_id=YOUR_AWS_ACCESS_KEY\nexport focus_regex=\"GENERAL AWS|AWS V2 REGION|AWS V4 REGION|AWS US-EAST-1\"\nexport region_name=us-east-1\nexport s3_endpoint_host=s3.amazonaws.com\nexport secret_access_key=YOUR_SECRET_ACCESS_KEY\nexport stack_name=s3cli-iam\nexport bucket_name=s3cli-pipeline\n```\n\nRun `ci/tasks/setup-aws-infrastructure.sh` and `ci/tasks/teardown-infrastructure.sh` before and after the `run-integration-*` tests in `ci/tasks`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fbosh-s3cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry%2Fbosh-s3cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry%2Fbosh-s3cli/lists"}