{"id":22542318,"url":"https://github.com/infura/ipfs-pump","last_synced_at":"2025-04-09T22:43:19.338Z","repository":{"id":50094346,"uuid":"193126304","full_name":"INFURA/ipfs-pump","owner":"INFURA","description":"A tool to transfer data between IPFS nodes or storage","archived":false,"fork":false,"pushed_at":"2023-04-25T21:13:33.000Z","size":79,"stargazers_count":60,"open_issues_count":2,"forks_count":16,"subscribers_count":37,"default_branch":"master","last_synced_at":"2025-03-24T00:41:24.928Z","etag":null,"topics":["ipfs"],"latest_commit_sha":null,"homepage":"","language":"Go","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/INFURA.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-21T16:03:14.000Z","updated_at":"2024-12-20T03:15:29.000Z","dependencies_parsed_at":"2024-06-18T21:22:36.972Z","dependency_job_id":"9634e9a9-0dca-4ae7-b776-c727fa4923ee","html_url":"https://github.com/INFURA/ipfs-pump","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INFURA%2Fipfs-pump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INFURA%2Fipfs-pump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INFURA%2Fipfs-pump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/INFURA%2Fipfs-pump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/INFURA","download_url":"https://codeload.github.com/INFURA/ipfs-pump/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248125147,"owners_count":21051760,"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":["ipfs"],"created_at":"2024-12-07T13:09:42.692Z","updated_at":"2025-04-09T22:43:19.313Z","avatar_url":"https://github.com/INFURA.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ipfs-pump\n\n`ipfs-pump` is a command line tool to copy data between IPFS nodes, cluster or storage.\n\nIt support multiple interfaces:\n- the IPFS API\n- direct access to a FlatFS datastore\n- direct access to a Badger datastore\n- direct access to a S3 datastore\n- a file with a list of CID\n\n## Concepts\n\nAn `Enumerator` is a source that will enumerate the list of existing blocks.\n\nA `Collector` is a source that where to retrieve block's data.\n\nA `Drain` is a destination where to push blocks.\n\nNote: even though you will likely want the `Enumerator` and the `Collector` to be the same source, they don't necessarily have to.\n\n## Install\n\n```\ngo get -u github.com/INFURA/ipfs-pump\n```\n\n## Usage and examples\n\nYou need to provide as arguments the three types of `Enumerator`, `Collector` and `Drain`, as well as the corresponding configuration flags.\n\nCopy between two live nodes using the API:\n\n```\nipfs-pump \\\n    apipin --enum-api-pin-url=127.0.0.1:5001 --enum-api-pin-stream \\\n    api --coll-api-url=127.0.0.1:5001 \\\n    api --drain-api-url=127.0.0.1:5002 \\\n    --worker=10\n```\n\nCopy from a FlatFS storage to a Badger storage when the nodes are stopped:\n\n```\nipfs-pump \\\n    flatfs --enum-flatfs-path=~/.ipfs/blocks \\\n    flatfs --coll-flatfs-path=~/.ipfs/blocks \\\n    badger --drain-badger-path=~/.ipfs/badgerds \\\n    --worker=50\n```\n\n## Parallel processing\n\nUsing the `--worker` flag you can enable parallel processing and greatly increase the throughput.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfura%2Fipfs-pump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfura%2Fipfs-pump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfura%2Fipfs-pump/lists"}