{"id":13510234,"url":"https://github.com/hypercore-protocol/cli","last_synced_at":"2026-01-12T08:41:51.600Z","repository":{"id":43112832,"uuid":"318582978","full_name":"hypercore-protocol/cli","owner":"hypercore-protocol","description":"A CLI for peer-to-peer file sharing using the Hypercore Protocol.","archived":false,"fork":false,"pushed_at":"2022-08-18T08:03:03.000Z","size":153,"stargazers_count":205,"open_issues_count":25,"forks_count":17,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-01T10:35:16.598Z","etag":null,"topics":["hyperbee","hypercore","hyperdrive","hyperspace","p2p"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/hypercore-protocol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-04T17:07:23.000Z","updated_at":"2024-09-26T02:46:01.000Z","dependencies_parsed_at":"2022-09-24T20:12:55.771Z","dependency_job_id":null,"html_url":"https://github.com/hypercore-protocol/cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercore-protocol%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercore-protocol%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercore-protocol%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypercore-protocol%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypercore-protocol","download_url":"https://codeload.github.com/hypercore-protocol/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246338735,"owners_count":20761426,"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":["hyperbee","hypercore","hyperdrive","hyperspace","p2p"],"created_at":"2024-08-01T02:01:30.101Z","updated_at":"2026-01-12T08:41:51.595Z","avatar_url":"https://github.com/hypercore-protocol.png","language":"JavaScript","readme":"# NOTE\n\nThe CLI is currently mostly out of date, tracking the previous major version of the Hypercore stack.\n\nCheck out the individual repos instead, like [Hypercore](https://github.com/hypercore-protocol/hypercore), [Hyperbee](https://github.com/hypercore-protocol/hyperbee), [Hyperbeam](https://github.com/mafintosh/hyperbeam), [Hyperswarm](https://github.com/hyperswarm)\n\n\u003cdetails\u003e\u003csummary\u003eClick to see the CLI README still\u003c/summary\u003e\n  \n# Hyp\n\n\u003cp\u003e[\n  \u003ca href=\"https://www.youtube.com/watch?v=SVk1uIQxOO8\" target=\"_blank\"\u003eDemo Video\u003c/a\u003e |\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e |\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e |\n  \u003ca href=\"#overview\"\u003eOverview\u003c/a\u003e |\n  \u003ca href=\"https://hypercore-protocol.org/guides/hyp/\"\u003eWebsite\u003c/a\u003e\n]\u003c/p\u003e\n\nA CLI for peer-to-peer file sharing (and more) using the [Hypercore Protocol](https://hypercore-protocol.org).\n\n\u003ca href=\"https://www.youtube.com/watch?v=SVk1uIQxOO8\" target=\"_blank\"\u003e📺 Watch The Demo Video\u003c/a\u003e\n\n## Installation\n\nRequires nodejs 14+\n\n```\nnpm install -g @hyperspace/cli\n```\n\nTo start using the network, run:\n\n```\nhyp daemon start\n```\n\nThis will run in the background, sync data for you, until you run:\n\n```\nhyp daemon stop\n```\n\n## Usage\n\nCommand overview:\n\n```bash\nUsage: hyp \u003ccommand\u003e [opts...]\n\nGeneral Commands:\n\n  hyp info [urls...] - Show information about one (or more) hypers.\n  hyp seed {urls...} - Download and make hyper data available to the network.\n  hyp unseed {urls...} - Stop making hyper data available to the network.\n  hyp create {drive|bee} - Create a new hyperdrive or hyperbee.\n\n  hyp beam {pass_phrase} - Send a stream of data over the network.\n\nHyperdrive Commands:\n\n  hyp drive ls {url} - List the entries of the given hyperdrive URL.\n  hyp drive mkdir {url} - Create a new directory at the given hyperdrive URL.\n  hyp drive rmdir {url} - Remove a directory at the given hyperdrive URL.\n\n  hyp drive cat {url} - Output the content of the given hyperdrive URL.\n  hyp drive put {url} [content] - Write a file at the given hyperdrive URL.\n  hyp drive rm {url} - Remove a file or (if --recursive) a folder at the given hyperdrive URL.\n\n  hyp drive diff {source_path_or_url} {target_path_or_url} - Compare two folders in your local filesystem or in hyperdrives. Can optionally \"commit\" the difference.\n  hyp drive sync {source_path_or_url} [target_path_or_url] - Continuously sync changes between two folders in your local filesystem or in hyperdrives.\n\n  hyp drive http {url} - Host a hyperdrive as using HTTP on the localhost.\n\nHyperbee Commands:\n\n  hyp bee ls {url} - List the entries of the given hyperbee URL.\n  hyp bee get {url} - Get the value of an entry of the given hyperbee URL.\n  hyp bee put {url} [value] - Set the value of an entry of the given hyperbee URL.\n  hyp bee del {url} - Delete an entry of the given hyperbee URL.\n\nDaemon Commands:\n\n  hyp daemon status - Check the status of the hyperspace daemon.\n  hyp daemon start - Start the hyperspace daemon.\n  hyp daemon stop - Stop the hyperspace and mirroring daemons if active.\n\nAliases:\n\n  hyp sync -\u003e hyp drive sync\n  hyp diff -\u003e hyp drive diff\n  hyp ls -\u003e hyp drive ls\n  hyp cat -\u003e hyp drive cat\n  hyp put -\u003e hyp drive put\n```\n\n## Overview\n\nThe [Hypercore Protocol](https://hypercore-protocol.org) is a peer-to-peer network for sharing files and data. This command-line provides a convenient set of tools for accessing the network.\n\nThere are two common kinds of \"Hypercores\":\n\n- **Hyperdrive** A folder containing files.\n- **Hyperbee** A key-value database (similar to leveldb).\n\nAll data has a URL which starts with `hyper://`. A URL will look like this:\n\n```\nhyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/\n```\n\nYou use these URLs to access the hyper data over the peer-to-peer network. For example:\n\n```\nhyp ls hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/\nhyp cat hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/file.txt\ncat diagram.png | hyp put 515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/diagram.png\n```\n\nYou can create a new hyperdrive or hyperbee using the `create` commands:\n\n```\nhyp create drive\n```\n\nYou can then seed the hyper (or seed a hyper created by somebody else) using the `seed` command:\n\n```\nhyp seed hyper://515bbbc1db2139ef27b6c45dfa418c8be6a1dec16823ea7cb9e61af8d060049e/\n```\n\nTo see what hypers you are currently seeding, run `info`:\n\n```\nhyp info\n```\n\n## Documentation\n\nThe [website documentation](https://hypercore-protocol.org/guides/hyp/) have a lot of useful guides:\n\n- [Full Commands Reference](https://hypercore-protocol.org/guides/hyp/commands/)\n- [Guide: Sharing Folders](https://hypercore-protocol.org/guides/hyp/sharing-folders/)\n- [Guide: Seeding Data](https://hypercore-protocol.org/guides/hyp/seeding-data/)\n- [Guide: Beaming Files](https://hypercore-protocol.org/guides/hyp/beaming-files/)\n\u003c/details\u003e\n","funding_links":[],"categories":["JavaScript","p2p"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercore-protocol%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypercore-protocol%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypercore-protocol%2Fcli/lists"}