cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity
0444435589
lotus/documentation/en
History
Peter Rabbitson 0444435589 Expose basic text-based datamodel selector on retrieval 
Syntaxt of selection is located at
https://pkg.go.dev/github.com/ipld/go-ipld-selector-text-lite#SelectorSpecFromPath

Example use, assuming that:
  - The root of the deal is a plain dag-pb unixfs directory
  - The directory is not sharded
  - The user wants to retrieve the first entry in that directory

  lotus client retrieve --miner f0XXXXX --datamodel-path-selector 'Links/0/Hash' bafyROOTCID ~/output

For a much more elaborate example see the top of ./itests/deals_partial_retrieval_test.go
2021-09-10 09:44:11 +02:00
..
architecture segregate chain and state blockstores. 2021-02-28 22:49:44 +00:00
.glossary.json Delete most docs. Update about page with links to docs.filecoin.io 2020-09-17 20:35:19 +02:00
.library.json Delete most docs. Update about page with links to docs.filecoin.io 2020-09-17 20:35:19 +02:00
about.md Delete most docs. Update about page with links to docs.filecoin.io 2020-09-17 20:35:19 +02:00
api-v0-methods-miner.md docsgen 2021-09-07 18:49:53 +02:00
api-v0-methods-worker.md revert pricelist by version to pricelist by epoch 2021-08-11 09:49:23 -04:00
api-v0-methods.md Expose basic text-based datamodel selector on retrieval 2021-09-10 09:44:11 +02:00
api-v1-unstable-methods.md Expose basic text-based datamodel selector on retrieval 2021-09-10 09:44:11 +02:00
block-validation.md Move unclassified docs back to the docs root 2020-09-21 19:05:49 +02:00
cli-lotus-miner.md Add --unproven flag to the sectors list command 2021-09-09 23:29:52 +02:00
cli-lotus-worker.md bump master to v1.11.4-dev 2021-09-08 01:23:35 -04:00
cli-lotus.md Expose basic text-based datamodel selector on retrieval 2021-09-10 09:44:11 +02:00
create-miner.md Move unclassified docs back to the docs root 2020-09-21 19:05:49 +02:00
dev-tools-pond-ui.md Move unclassified docs back to the docs root 2020-09-21 19:05:49 +02:00
jaeger-tracing.md update jaeger documentation 2021-05-25 23:53:08 -07:00
README.md Add README to documentation/en with explanations 2020-09-29 14:45:55 +02:00
sealing-procs.md Move unclassified docs back to the docs root 2020-09-21 19:05:49 +02:00
WIP-arch-complementary-notes.md Move unclassified docs back to the docs root 2020-09-21 19:05:49 +02:00

README.md

Lotus documentation

This folder contains some Lotus documentation mostly intended for Lotus developers.

User documentation (including documentation for miners) has been moved to specific Lotus sections in https://docs.filecoin.io:

The Lotu.sh site

The https://lotu.sh and https://docs.lotu.sh sites are generated from this folder based on the index provided by .library.json. This is done at the lotus-docs repository, which contains Lotus as a git submodule.

To update the site, the lotus-docs repository should be updated with the desired version for the lotus git submodule. Once pushed to master, it will be auto-deployed.