{"id":21643902,"url":"https://github.com/application-research/barge","last_synced_at":"2025-04-11T18:21:35.929Z","repository":{"id":44334109,"uuid":"511368541","full_name":"application-research/barge","owner":"application-research","description":"Barge - CLI tool to stream/upload files/cars/dirs to Estuary","archived":false,"fork":false,"pushed_at":"2022-11-22T21:01:56.000Z","size":754,"stargazers_count":6,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T18:21:33.403Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","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/application-research.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-07-07T03:22:49.000Z","updated_at":"2025-02-06T11:20:43.000Z","dependencies_parsed_at":"2023-01-21T17:18:17.874Z","dependency_job_id":null,"html_url":"https://github.com/application-research/barge","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/application-research%2Fbarge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Fbarge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Fbarge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/application-research%2Fbarge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/application-research","download_url":"https://codeload.github.com/application-research/barge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456387,"owners_count":21106607,"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-25T05:36:48.706Z","updated_at":"2025-04-11T18:21:35.901Z","avatar_url":"https://github.com/application-research.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Estuary Barge\nBarge is a CLI tool that directly uses estuary api to stream/upload files to the filecoin network.\n\n![image](https://user-images.githubusercontent.com/4479171/178054186-70c482f9-679d-4ab0-9f3d-e8ffa6ce49a7.png)\n\n\n*This project is based on the a sub module on Estuary under /cmd/barge.* \n\n## Installation\n### Pre-requisites\n- Go\n- make\n- filecoin-ffi (this is a submodule)\n\nClone this repo and run the following\n```\nmake all\n```\nThis will generate a `barge` binary on the root folder that you can test.\n\n## Usage\n\n### Grab your API key from Estuary and run the following:\n```\n./barge login \u003cAPI KEY\u003e\n```\n\n### Initialize\nInitialize barge with the following command. This will create a configuration file which\nholds the estuary connection information.\n```\n./barge init \n```\n\n### Local configuration file\n```\n{\n  \"estuary\": {\n    \"host\": \"http://localhost:3004\",\n    \"primaryshuttle\": \"http://localhost:3005\",\n    \"token\": \"\u003clocal API token\u003e\"\n  }\n}\n```\n\n### Remote Estuary configuration\n```\n{\n  \"estuary\": {\n    \"host\": \"https://api.estuary.tech\",\n    \"primaryshuttle\": \"https://upload.estuary.tech\",\n    \"token\": \"\u003cEstuary API token\u003e\"\n  }\n}\n```\n\n## Usage\n### Upload a file\n```\n./barge plumb put-file \u003cfile path\u003e\n```\n\n### Upload a CAR file\n```\n./barge plumb put-car \u003cCAR file path\u003e\n```\n\n## WebUI\nRun Web\n```\n./barge web\n```\n\n[http://localhost:3000](http://localhost:3000)\n\n## REST API Endpoints\nRun Web and use the following endpoints to interact with the barge.\n```\n./barge web\n```\n\n### Upload file\n```\ncurl --location --request POST 'http://localhost:3000/api/v0/plumb/file' \\\n--form 'file=@\"website.png\"'\n```\n\n### Upload CAR\n```\ncurl --location --request POST 'http://localhost:3000/api/v0/plumb/car' \\\n--form 'file=@\"file.car\"'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplication-research%2Fbarge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapplication-research%2Fbarge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplication-research%2Fbarge/lists"}