{"id":28170328,"url":"https://github.com/pinatacloud/chi","last_synced_at":"2026-02-10T23:31:34.312Z","repository":{"id":278642529,"uuid":"924099891","full_name":"PinataCloud/chi","owner":"PinataCloud","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-20T21:17:31.000Z","size":164,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-23T19:47:48.756Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/PinataCloud.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":"2025-01-29T12:18:41.000Z","updated_at":"2025-06-20T02:14:23.000Z","dependencies_parsed_at":"2025-02-20T22:25:50.235Z","dependency_job_id":"b1db9ec5-9ab4-44bf-b11b-3b570acdbe22","html_url":"https://github.com/PinataCloud/chi","commit_stats":null,"previous_names":["pinatacloud/chi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PinataCloud/chi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fchi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fchi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fchi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fchi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PinataCloud","download_url":"https://codeload.github.com/PinataCloud/chi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PinataCloud%2Fchi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29321336,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-10T20:44:44.282Z","status":"ssl_error","status_checked_at":"2026-02-10T20:44:43.393Z","response_time":65,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2025-05-15T17:19:05.892Z","updated_at":"2026-02-10T23:31:34.293Z","avatar_url":"https://github.com/PinataCloud.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Chi\n\n**A light and portable IPFS sync engine**\n\nChi provides an easy way to sync files local IPFS files with pinning services like [Pinata](https://pinata.cloud). By setting the `KUBO_URL` you can interface an IPFS node running locally or in a cloud environment. Additional pinning services can be added as well through the `config.ts` file by providing the name, endpoint, and API key for the service.\n\n## Quickstart\n\nIn this quickstart we'll show you how to start using Chi along side a Kubo node\n\n### IPFS Kubo Setup\n\nTo start using Chi make sure you already have an IPFS node available.\n\n**Local**\n\n[Install Kubo](https://docs.ipfs.tech/install/command-line/#system-requirements) and then run the daemon in your terminal:\n\n```bash\nipfs daemon\n```\n\nThis will make your node accessible through `http://127.0.0.1:5001` (aka your `KUBO_URL`)\n\n**Cloud**\n\nThere are multiple ways you can run Kubo in cloud infrastructure. One of the easiest we've seen is through a Docker image through a service like [Railway](https://railway.com). Simply spin up a new app, click `+Create` in the top right, then select `Docker Image`. Then use `ipfs/kubo` as the name. This should spin up the daemon automatically, and you will either need to make the endpoint accessible or connect Chi to it in Railway as well.\n\n### Chi Setup\n\nClone the repo and install dependencies\n\n```bash\ngit clone https://github.com/PinataCloud/chi\ncd chi\nnpm install\n```\n\nRename the `.env.example` file to `.env` and edit the `KUBO_URL` if applicable. There is also a `PINATA_JWT` variable if you want to use Pinata as a pinning service. In the `config.ts` file you can edit or add more pinning services you want to sync with.\n\nAfter the variables are filled out start up the server with the command below:\n\n```bash\nnpm run dev\n```\n\nThis should spin up a dev server on `http://localhost:3000` where the API can be accessed\n\n## Usage\n\nThe Chi API has just two simple endpoints you can use to upload files and list them\n\n**`POST /upload`**\n\nUsing a multipart formdata request you can upload a file to your IPFS node which will then trigger a sync upload to your pinning service. Here's an example in Typescript:\n\n```typescript\nconst file = new File([\"Hello IPFS!\"], \"hello.txt\", { type: \"plain/text\" })\nconst data = new FormData()\ndata.append(\"file\", file)\nconst request = await fetch(\"http://localhost:3000/upload\", {\n  method: \"POST\",\n  body: data\n})\nconst response = await request.json()\nconsole.log(response)\n```\n\n**`GET /pins/list`**\n\nGet a list of your pins by making a simple GET request to `/pins/list`\n\n```typescript\nconst request = await fetch(\"http://localhost:3000/pins/list\")\nconst response = await request.json()\nconsole.log(response)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinatacloud%2Fchi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpinatacloud%2Fchi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpinatacloud%2Fchi/lists"}