diff --git a/api-code-examples/api.mjs b/api-code-examples/api.mjs index b9359d1..3ad3041 100644 --- a/api-code-examples/api.mjs +++ b/api-code-examples/api.mjs @@ -459,36 +459,12 @@ const blobs = [ description: 'Add data from PATH to the running node', slug: 'blobs-add', arguments: [ - { - name: 'source', - necessity: 'required', - description: 'Path to a file or folder' - }, - { - name: 'in-place', - necessity: '', - description: 'Add in place' - }, - { - name: 'tag', - necessity: '', - description: 'Tag to tag the data with' - }, - { - name: 'wrap', - necessity: '', - description: 'Wrap the added file or directory in a collection' - }, - { - name: 'filename', - necessity: '', - description: 'Override the filename used for the entry in the created collection' - }, - { - name: 'no-ticket', - necessity: '', - description: 'Do not print the all-in-one ticket to get the added data from this node' - } + { name: 'source', necessity: 'required', description: 'Path to a file or folder' }, + { name: 'in-place', necessity: '', description: 'Add in place' }, + { name: 'tag', necessity: '', description: 'Tag to tag the data with' }, + { name: 'wrap', necessity: '', description: 'Wrap the added file or directory in a collection' }, + { name: 'filename', necessity: '', description: 'Override the filename used for the entry in the created collection' }, + { name: 'no-ticket', necessity: '', description: 'Do not print the all-in-one ticket to get the added data from this node' } ], examples: { console: `> blobs add ~/my_txt.txt @@ -496,69 +472,27 @@ Adding my_txt.txt as /Users/me/my_txt.txt... - /Users/me/my_txt.txt: 328 B bafkr4igef2yiz2nz33tljfdezzr45cos5lnc2urjmfi6zghbsnfzvpdpa4 Total: 328 B -Collection: bafkr4ie3xsx3vdsbflainnk6p4xs4h2hq3hdmuasuoflkgybvnsbljb3ke` +Collection: bafkr4ie3xsx3vdsbflainnk6p4xs4h2hq3hdmuasuoflkgybvnsbljb3ke`, } }, { - name: 'blobs download', + name: 'blobs download', // console and cli blobs get description: 'Download data to the running node\'s database and provide it', slug: 'blobs-get', arguments: [ - { - name: 'ticket or hash', - necessity: 'required', - description: 'Ticket or Hash to use' - }, - { - name: 'address', - necessity: '', - description: 'Additional socket address to use to contact the node. Can be used multiple times' - }, - { - name: 'relay-url', - necessity: '', - description: 'Override the relay URL to use to contact the node' - }, - { - name: 'recursive', - necessity: '', - description: 'Override to treat the blob as a raw blob or a hash sequence' - }, - { - name: 'override-addresses', - necessity: '', - description: 'If set, the ticket\'s direct addresses will not be used' - }, - { - name: 'node', - necessity: '', - description: 'NodeId of the provider' - }, - { - name: 'out', - necessity: '', - description: 'Directory or file in which to save the file(s)' - }, - { - name: 'stable', - necessity: '', - description: 'If set, the data will be moved to the output directory, and iroh will assume that it will not change' - }, - { - name: 'tag', - necessity: '', - description: 'Tag to tag the data with' - }, - { - name: 'queued', - necessity: '', - description: 'If set, will queue the download in the download queue' - } + { name: 'ticket or hash', necessity: 'required', description: 'Ticket or Hash to use' }, + { name: 'address', necessity: '', description: 'Additional socket address to use to contact the node. Can be used multiple times' }, + { name: 'relay-url', necessity: '', description: 'Override the relay URL to use to contact the node' }, + { name: 'recursive', necessity: '', description: 'Override to treat the blob as a raw blob or a hash sequence' }, + { name: 'override-addresses', necessity: '', description: 'If set, the ticket\'s direct addresses will not be used' }, + { name: 'node', necessity: '', description: 'NodeId of the provider' }, + { name: 'out', necessity: '', description: 'Directory or file in which to save the file(s)' }, + { name: 'stable', necessity: '', description: 'If set, the data will be moved to the output directory, and iroh will assume that it will not change' }, + { name: 'tag', necessity: '', description: 'Tag to tag the data with' }, + { name: 'queued', necessity: '', description: 'If set, will queue the download in the download queue' } ], examples: { - console: `> blobs get his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a --address 192.168.0.15:41918 --node w3mj2iw47i2pgbdrnutaamsqm6h2bj6r7yp7h2vliruq3vry535a -Fetching: his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a -Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` + console: '> blobs get' } }, { @@ -566,29 +500,13 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` description: 'Export a blob from the internal blob store to the local filesystem', slug: 'blobs-export', arguments: [ - { - name: 'hash', - necessity: 'required', - description: 'The hash to export' - }, - { - name: 'out', - necessity: 'required', - description: 'Directory or file in which to save the file(s)' - }, - { - name: 'recursive', - necessity: '', - description: 'Set to true if the hash refers to a collection and you want to export all children of the collection' - }, - { - name: 'stable', - necessity: '', - description: 'If set, the data will be moved to the output directory, and iroh will assume that it will not change' - } + { name: 'hash', necessity: 'required', description: 'The hash to export' }, + { name: 'out', necessity: 'required', description: 'Directory or file in which to save the file(s)' }, + { name: 'recursive', necessity: '', description: 'Set to true if the hash refers to a collection and you want to export all children of the collection' }, + { name: 'stable', necessity: '', description: 'If set, the data will be moved to the output directory, and iroh will assume that it will not change' } ], examples: { - console: '> blobs export his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a ./very_important.txt' + console: '> blobs export' } }, { @@ -609,7 +527,7 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` }, { name: 'blobs list incomplete-blobs', - description: 'List the blobs on the running provider that are not full files', + description: 'List the available blobs on the running provider', slug: 'blobs-list-incomplete-blobs', arguments: [], examples: { @@ -622,8 +540,7 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` slug: 'blobs-list-collections', arguments: [], examples: { - console: `> blobs list collections -"auto-2024-08-20T17:49:54.244Z": myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua 3 blobs (0 B)` + console: '> blobs list collections' } }, { @@ -631,16 +548,8 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` description: 'Validate hashes on the running node', slug: 'blobs-validate', arguments: [ - { - name: 'verbose', - necessity: '', - description: '' - }, - { - name: 'repair', - necessity: '', - description: 'Repair the store by removing invalid data' - } + { name: 'verbose', necessity: '', description: '' }, + { name: 'repair', necessity: '', description: 'Repair the store by removing invalid data' } ], examples: { console: '> blobs validate' @@ -651,16 +560,8 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` description: 'Perform a database consistency check on the running node', slug: 'blobs-consistency-check', arguments: [ - { - name: 'verbose', - necessity: '', - description: '' - }, - { - name: 'repair', - necessity: '', - description: 'Repair the store by removing invalid data' - } + { name: 'verbose', necessity: '', description: '' }, + { name: 'repair', necessity: '', description: 'Repair the store by removing invalid data' } ], examples: { console: '> blobs consistency-check' @@ -671,13 +572,10 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` description: 'Delete the given blobs', slug: 'blobs-delete-blob', arguments: [ - { - name: 'hash', - necessity: 'required', - description: 'Blobs to delete' - } + { name: 'hash', necessity: 'required', description: 'Blobs to delete' } ], examples: { + console: '> blobs delete blob' } }, { @@ -685,26 +583,12 @@ Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s` description: 'Get a ticket to share this blob', slug: 'blobs-share', arguments: [ - { - name: 'hash', - necessity: 'required', - description: 'Hash of the blob to share' - }, - { - name: 'addr-options', - necessity: '', - description: 'Options to configure the address information in the generated ticket' - }, - { - name: 'recursive', - necessity: '', - description: 'If the blob is a collection, the requester will also fetch the listed blobs' - } + { name: 'hash', necessity: 'required', description: 'Hash of the blob to share' }, + { name: 'addr-options', necessity: '', description: 'Options to configure the address information in the generated ticket' }, + { name: 'recursive', necessity: '', description: 'If the blob is a collection, the requester will also fetch the listed blobs' } ], examples: { - console: `> blobs share myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua -Ticket for blob myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua (96 B) -blobac3nrhjc3t5dj4yeofwsmabskbty7ifh2h7b747kvncgsdowhdxpuaaaabtcrrhidtk7zld7ishgpqne6tpadty7it6j7ragdes3juts5uf6q` + console: '> blobs share' } } ] diff --git a/src/app/docs/api/blobs-consistency-check/page.mdx b/src/app/docs/api/blobs-consistency-check/page.mdx index ded6d1d..a4039ba 100644 --- a/src/app/docs/api/blobs-consistency-check/page.mdx +++ b/src/app/docs/api/blobs-consistency-check/page.mdx @@ -33,7 +33,4 @@ Perform a database consistency check on the running node {{ className: 'lead' }} > blobs consistency-check ``` - - - diff --git a/src/app/docs/api/blobs-delete-blob/page.mdx b/src/app/docs/api/blobs-delete-blob/page.mdx index a5e9f94..bb2ee7e 100644 --- a/src/app/docs/api/blobs-delete-blob/page.mdx +++ b/src/app/docs/api/blobs-delete-blob/page.mdx @@ -29,10 +29,9 @@ Delete the given blobs {{ className: 'lead' }} ```text {{ title: 'console' }} - +> blobs delete blob ``` - diff --git a/src/app/docs/api/blobs-export/page.mdx b/src/app/docs/api/blobs-export/page.mdx index 0d7a709..810d580 100644 --- a/src/app/docs/api/blobs-export/page.mdx +++ b/src/app/docs/api/blobs-export/page.mdx @@ -32,10 +32,9 @@ Export a blob from the internal blob store to the local filesystem {{ className: ```text {{ title: 'console' }} -> blobs export his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a ./very_important.txt +> blobs export ``` - diff --git a/src/app/docs/api/blobs-get/page.mdx b/src/app/docs/api/blobs-get/page.mdx index 379887e..13ae4cc 100644 --- a/src/app/docs/api/blobs-get/page.mdx +++ b/src/app/docs/api/blobs-get/page.mdx @@ -38,12 +38,9 @@ Download data to the running node's database and provide it {{ className: 'l ```text {{ title: 'console' }} -> blobs get his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a --address 192.168.0.15:41918 --node w3mj2iw47i2pgbdrnutaamsqm6h2bj6r7yp7h2vliruq3vry535a -Fetching: his7xcvl5jc734mwbtgtkkvxeafrdcitmg2jvdmxk7ri7abgr33a -Transferred 14.20 KiB in 0 seconds, 173.20 KiB/s +> blobs get ``` - diff --git a/src/app/docs/api/blobs-list-collections/page.mdx b/src/app/docs/api/blobs-list-collections/page.mdx index 6bc9016..f6b6ead 100644 --- a/src/app/docs/api/blobs-list-collections/page.mdx +++ b/src/app/docs/api/blobs-list-collections/page.mdx @@ -23,7 +23,6 @@ List the available collections on the running provider {{ className: 'lead' }} ```text {{ title: 'console' }} > blobs list collections -"auto-2024-08-20T17:49:54.244Z": myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua 3 blobs (0 B) ``` ```rust {{ title: 'rust' }} diff --git a/src/app/docs/api/blobs-list-incomplete-blobs/page.mdx b/src/app/docs/api/blobs-list-incomplete-blobs/page.mdx index 9c0e57c..4af3edb 100644 --- a/src/app/docs/api/blobs-list-incomplete-blobs/page.mdx +++ b/src/app/docs/api/blobs-list-incomplete-blobs/page.mdx @@ -2,7 +2,7 @@ import Breadcrumbs from '@/components/Breadcrumbs' export const metadata = { title: "blobs list incomplete-blobs", - description: "List the blobs on the running provider that are not full files" + description: "List the available blobs on the running provider" }
@@ -14,7 +14,7 @@ export const metadata = { # blobs list incomplete-blobs -List the blobs on the running provider that are not full files {{ className: 'lead' }} +List the available blobs on the running provider {{ className: 'lead' }} diff --git a/src/app/docs/api/blobs-share/page.mdx b/src/app/docs/api/blobs-share/page.mdx index 02527dd..781fc22 100644 --- a/src/app/docs/api/blobs-share/page.mdx +++ b/src/app/docs/api/blobs-share/page.mdx @@ -31,12 +31,9 @@ Get a ticket to share this blob {{ className: 'lead' }} ```text {{ title: 'console' }} -> blobs share myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua -Ticket for blob myumj2a42x6ky72erzt4djhu3ya46h2e7sp4ibqzew2ne4xnbpua (96 B) -blobac3nrhjc3t5dj4yeofwsmabskbty7ifh2h7b747kvncgsdowhdxpuaaaabtcrrhidtk7zld7ishgpqne6tpadty7it6j7ragdes3juts5uf6q +> blobs share ``` - diff --git a/src/app/docs/api/blobs-validate/page.mdx b/src/app/docs/api/blobs-validate/page.mdx index d3b6569..5768bc0 100644 --- a/src/app/docs/api/blobs-validate/page.mdx +++ b/src/app/docs/api/blobs-validate/page.mdx @@ -35,5 +35,4 @@ Validate hashes on the running node {{ className: 'lead' }} -