{"id":21399299,"url":"https://github.com/streamr-dev/streamrfs","last_synced_at":"2025-10-10T05:16:29.188Z","repository":{"id":228691440,"uuid":"307460377","full_name":"streamr-dev/StreamrFS","owner":"streamr-dev","description":"File sharing extension for Streamr real-time data protocol","archived":false,"fork":false,"pushed_at":"2020-10-26T18:07:25.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-16T03:45:46.002Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/streamr-dev.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-10-26T17:57:47.000Z","updated_at":"2023-03-14T16:45:12.000Z","dependencies_parsed_at":"2024-03-20T02:10:43.632Z","dependency_job_id":"3ea04243-58b8-40e1-a86b-3ed35522da0e","html_url":"https://github.com/streamr-dev/StreamrFS","commit_stats":null,"previous_names":["streamr-dev/streamrfs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streamr-dev%2FStreamrFS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streamr-dev%2FStreamrFS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streamr-dev%2FStreamrFS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/streamr-dev%2FStreamrFS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/streamr-dev","download_url":"https://codeload.github.com/streamr-dev/StreamrFS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243892293,"owners_count":20364677,"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-22T15:14:01.936Z","updated_at":"2025-10-10T05:16:29.091Z","avatar_url":"https://github.com/streamr-dev.png","language":"JavaScript","readme":"# StreamrFS\n\n**Warning: Insecure at the moment! To be secure, a version of the Streamr JS client that supports end-to-end encryption with automatic key exchange. This is coming soon. Only use for testing and prototyping at the moment.**\n\nAn application-level extension on top of Streamr protocol to standardize file sharing in the Streamr ecosystem.\n\nThis npm package includes a library and a CLI tool for interacting with resources that follow the StreamrFS specification.\n\n## About\n\nStreamr is a protocol for real-time data sharing. However, its pub/sub messaging, message storage, permissions, and automatic exchange of encryption keys can be leveraged to implement a file sharing system as a higher-level protocol on top of the underlying primitives.\n\nThe basics of how StreamrFS works:\n - Streams are used to publish pointers to files stored elsewhere (with potential support for various file transfer protocols as plugins: HTTP, IPFS, Bittorrent, etc.) \n - For each file, there is a corresponding Streamr stream. \n - Messages in the stream contain the necessary information for downloading and decrypting the shared file. \n - The latest message in a stream corresponds to the latest version of a file. Older messages may reference previous versions of the file, allowing for full version histories out-of-the-box.\n - If a file is updated or moved, a new message is published to the corresponding stream.`\n\n## Usage (CLI)\n\nInstall with: `npm install -g streamrfs`\n\n## Getting help\n\nJust run `streamrfs`:\n\n```\nUsage: streamrfs \u003ccommand\u003e [\u003cargs\u003e]\n\nCommand line tool for using StreamrFS, a file sharing extension on top of Streamr https://streamr.network\n\nOptions:\n  -V, --version   output the version number\n  -h, --help      display help for command\n\nCommands:\n  download        Download and decrypt a file from StreamrFS\n  encrypt         Encrypt a local file and persist the encryption key\n  publish         Publish a file, or update an existing file\n  decrypt         Decrypt an already downloaded file\n  help [command]  display help for command\n```\n\n### Downloading + decrypting files:\n\n`streamrfs download \u003cstreamId\u003e`\n\n### Encrypting + publishing files:\n\n```\n# Create a file you want to share\necho \"This is a file I want to share\" \u003e test.txt\n\n# Encrypt the file\nstreamrfs encrypt test.txt\n\n# Make note of the encryption key output by the encrypt command\n# Upload the output file test.txt.enc to some public url\n(upload test.txt.enc somewhere)\n\n# Publish the file location to a Streamr stream\nstreamrfs \u003cstreamId\u003e \u003curl\u003e \u003cencryptionKey\u003e \n```\n\n## Usage (as a library)\n\nInstall with: `npm install --save streamr-fs`\n\nTODO\n\n## StreamrFS Message Format\n\nStreamrFS file sharing uses messages with a certain JSON format specified here. These messages are published in end-to-end encrypted form to Streamr streams in order to communicate them to valid subscribers. \n\nA StreamrFS (version 1) message looks like this:\n\n```\n{\n  \"streamrFSVersion\": 1,                    // specifies StreamrFS version\n  \"url\": \"https://url-to-encrypted-file\",   // protocol and locator for the file\n  \"key\": \"hex-encoded-AES-key\",             // AES key to decrypt the file\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreamr-dev%2Fstreamrfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstreamr-dev%2Fstreamrfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstreamr-dev%2Fstreamrfs/lists"}