{"id":15497183,"url":"https://github.com/jwerle/hyperdrive-cli","last_synced_at":"2025-04-22T21:32:47.103Z","repository":{"id":57270185,"uuid":"121058714","full_name":"jwerle/hyperdrive-cli","owner":"jwerle","description":"Simpe CLI for a HyperDrive","archived":false,"fork":false,"pushed_at":"2019-04-26T00:16:27.000Z","size":10,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T19:03:00.827Z","etag":null,"topics":["cli","command-line","hyperdrive","p2p"],"latest_commit_sha":null,"homepage":null,"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/jwerle.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}},"created_at":"2018-02-10T22:09:57.000Z","updated_at":"2020-05-19T03:17:42.000Z","dependencies_parsed_at":"2022-08-25T02:51:37.387Z","dependency_job_id":null,"html_url":"https://github.com/jwerle/hyperdrive-cli","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Fhyperdrive-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Fhyperdrive-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Fhyperdrive-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwerle%2Fhyperdrive-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwerle","download_url":"https://codeload.github.com/jwerle/hyperdrive-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249860545,"owners_count":21336106,"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":["cli","command-line","hyperdrive","p2p"],"created_at":"2024-10-02T08:31:28.809Z","updated_at":"2025-04-22T21:32:47.086Z","avatar_url":"https://github.com/jwerle.png","language":"JavaScript","readme":"hyperdrive-cli\n==============\n\nSimpe CLI for a HyperDrive as a quick alternative to\n[dat-cli](https://github.com/datproject/dat).\n\n## Installation\n\n```sh\n$ npm install hyperdrive-cli -g\n```\n\n## Usage\n\n```sh\n\nUsage: hyperdrive: [-hDV] [--help] [--version]\n       hyperdrive: \u003ccommand\u003e [options] -- [pathspec]\n\n\nCommands:\n  init           Initialize a new archive\n  info           Show public information about the archive\n  stat           Stat a file or directory\n  read           Read a range from a file (Requires public key)\n  serve          Serve a hyperdrive over HTTP\n  write          Write to a file (Requires secret key)\n  unlink         Remove a file (Requires secret key)\n  download       Download file or entire archive (Requires public key)\n\nAliases:\n  init           i, initialize\n  read           get, cat\n  serve          http\n  write          add, put, set\n  unlink         rm, delete, del, remove\n  upload         up\n  readdir        list, ls, l\n  download       down\n\nOptions:\n  --help, -h     Show this message\n  --version, -V  Output program version\n  --key, -k      Hyperdrive archive public key\n  --debug, -D    Enable debug output (DEBUG=hyperdrive:cli*)\n  --start, -S    Range start offset when using ranged streams\n  --end, -E      Range end offset when using ranged streams\n  --length, -L   Range length when using ranged streams\n  --port, -p     Port to bind HTTP server to\n  --ram, -M      Store in random access memory\n```\n\n## API\n\n### `$ hyperdrive init`\n\nInitialize a new archive\n\n### `$ hyperdrive info`\n\nShow public information about the archive\n\n### `$ hyperdrive stat`\n\nStat a file or directory\n\n### `$ hyperdrive read`\n\nRead a range from a file (Requires public key)\n\n### `$ hyperdrive write`\n\nWrite to a file (Requires secret key)\n\n### `$ hyperdrive serve`\n\nServe a hyperdrive over HTTP\n\n### `$ hyperdrive unlink`\n\nRemove a file (Requires secret key)\n\n### `$ hyperdrive download`\n\nDownload file or entire archive (Requires public key)\n\n## Configuration\n\nThis module uses [rc](https://github.com/dominictarr/rc) to allow things\nlike [hyperdiscovery](https://github.com/karissa/hyperdiscovery) to be\nconfigured. Hyperdrive options like the secret key for hypercore can also be\nspecified here. Create a `.hyperdriverc` file with your hyperdrive. See below\nfor an example object.\n\n```js\n{\n  \"drive\": {\n    \"sparse\": true,\n    \"secretKey\": \"...\"\n  },\n\n  \"discovery\": {\n    \"live\": true,\n    \"dns\": {\n      \"server\": [\"discovery1.publicbits.org\"],\n      \"domain\": \"dat.local\"\n    },\n  }\n}\n```\n\n## License\n\nMIT\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwerle%2Fhyperdrive-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwerle%2Fhyperdrive-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwerle%2Fhyperdrive-cli/lists"}