{"id":18877562,"url":"https://github.com/nftstorage/nft.storage-tools","last_synced_at":"2025-07-05T06:01:25.778Z","repository":{"id":40203506,"uuid":"361689621","full_name":"nftstorage/nft.storage-tools","owner":"nftstorage","description":"🛠 Utilities for working with nft.storage.","archived":false,"fork":false,"pushed_at":"2022-06-20T09:46:32.000Z","size":779,"stargazers_count":33,"open_issues_count":2,"forks_count":19,"subscribers_count":14,"default_branch":"main","last_synced_at":"2024-03-25T21:08:36.190Z","etag":null,"topics":["nft","storage","tools"],"latest_commit_sha":null,"homepage":"","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/nftstorage.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-26T09:20:48.000Z","updated_at":"2024-03-23T04:07:38.000Z","dependencies_parsed_at":"2022-06-26T21:39:15.827Z","dependency_job_id":null,"html_url":"https://github.com/nftstorage/nft.storage-tools","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fnft.storage-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fnft.storage-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fnft.storage-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nftstorage%2Fnft.storage-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nftstorage","download_url":"https://codeload.github.com/nftstorage/nft.storage-tools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223640440,"owners_count":17178012,"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":["nft","storage","tools"],"created_at":"2024-11-08T06:20:02.764Z","updated_at":"2024-11-08T06:20:03.375Z","avatar_url":"https://github.com/nftstorage.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nft.storage tools\n\nTools for working with nft.storage.\n\n## Usage\n\n1. Ensure [git](https://git-scm.com/) and [Node.js](https://nodejs.org) are installed.\n1. Clone this repo:\n    ```sh\n    git clone https://github.com/nftstorage/nft.storage-tools.git\n    cd nft.storage-tools\n    ```\n1. Install dependencies:\n    ```sh\n    npm install\n    ```\n1. Sign up for an account on [nft.storage](https://nft.storage) and create an API key.\n1. Create a `.env` file in the project root and add the following content:\n    ```sh\n    ENDPOINT=\"https://api.nft.storage\"\n    API_KEY=\"NFT_STORAGE_API_KEY\"\n    ```\n1. Choose a script from the root to run (usage instructions can be found at the top of the file) or instructions for some common [tasks](#tasks) can be found below.\n\n### Advanced (nft.storage developers only)\n\nTo talk directly to the nft.storage IPFS Cluster using the `cluster*.js` scripts, add the following to the `.env` file:\n\n```sh\nCLUSTER_URL=\"https://CLUSTER_DOMAIN/api/\"\nCLUSTER_HEADERS='{\"Authorization\":\"Basic CLUSTER_BASIC_AUTH_KEY\"}'\n```\n\n## Tasks\n\n### Import a list of CIDs\n\nYou have a list of CIDs for content you have stored in IPFS already and would like to import that content into nft.storage.\n\n1. Export CIDs to a newline delimited file. For example, you could use the following command:\n    ```sh\n    ipfs pin ls -q \u003e pinlist.txt\n    ```\n1. Follow the [usage instructions](#usage) above until the last step.\n1. Run the import script:\n    ```sh\n    node import.js pinlist.txt\n    ```\n    Note: if you need to stop the script, you can resume from a particular line number by passing `--start 1000` (to start from line 1,000).\n\nAfter nft.storage receives all your CIDs, it'll start to transfer data from peers that already have the content. This may take a long time for long lists of CIDs and may _fail_ if the content cannot be found on the IPFS network. You can [check the status of the CIDs you imported](#check-pinning-status-of-cid-list).\n\n### Check pinning status of CID list\n\nYou have previously imported a CID list and want to check to see progress of the pinning operations.\n\n1. Follow instructions for [importing a list of CIDs](#import-a-list-of-cids).\n1. Run the status checker script:\n    ```sh\n    node status.js pinlist.txt\n    ```\n    Note: failed and unknown CIDs are shown after all CIDs have been queried. These can be re-imported to attempt recovery.\n\n## Contributing\n\nFeel free to join in. All welcome. [Open an issue](https://github.com/nftstorage/nft.storage-tools/issues)!\n\n## License\n\nDual-licensed under [MIT](https://github.com/nftstorage/nft.storage-tools/blob/main/LICENSE-MIT) + [Apache 2.0](https://github.com/nftstorage/nft.storage-tools/blob/main/LICENSE-APACHE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fnft.storage-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnftstorage%2Fnft.storage-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnftstorage%2Fnft.storage-tools/lists"}