Conversation
894eea5 to
26634c5
Compare
|
@SgtPooki : I'm hoping you can help fill this out. It includes the things I wish I had seen documented when working on #299 as part of FilOzone/filecoin-services#380 today. No rush on this. Just didn't want to lose it before I move to other things. |
Added instructions for HTTP tracing on the CLI and clarified the importance of uploading unique data.
Co-authored-by: Rod Vagg <[email protected]>
SgtPooki
left a comment
There was a problem hiding this comment.
leaving some comments, will come back to fix
| # Run the cli | ||
| # This is the equivalent of running `filecoin-pin` if you had it installed globally (e.g., `npm install filecoin-pin -g`). | ||
| # It's like doing `npx filecoin-pin` that isn't stuck on that version until you `run npm install filecoin-pin -g` again. | ||
| node ./dist/cli.js |
There was a problem hiding this comment.
you can also run npx filecoin-pin or npx . to run the local version when you're in the package root. Note the foobar123 in the second npx filecoin-pin run when i'm in the package root.
~/code/work/filoz/filecoin-project
✔ ❯ npx filecoin-pin
Usage: filecoin-pin [options] [command]
IPFS Pinning Service with Filecoin storage via Synapse
SDK
Options:
-V, --version output the version number
-v, --verbose verbose output
--no-update-check skip check for updates
-h, --help display help for command
Commands:
server [options] Start the IPFS Pinning Service API server
payments Manage payment setup for Filecoin Onchain Cloud
data-set|dataset Inspect data sets managed through Filecoin Onchain Cloud
import [options] <file> Import an existing CAR file to Filecoin via Synapse
add [options] <path> Add a file or directory to Filecoin via Synapse (creates UnixFS CAR)
rm [options] Remove a Piece from a DataSet
~/code/work/filoz/filecoin-project
✔ ❯ cd filecoin-pin
direnv: loading https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.4/direnvrc (sha256-DzlYZ33mWF/Gs8DDeyjr8mnVmQGx7ASYqA5WlxwvBG4=)
direnv: export +PRIVATE_KEY_MAIN +PRIVATE_KEY_SUB +SHELL_DUMB +SHELL_INTERACTIVE +SHELL_LOGIN +SHELL_LOGIN2 +TEST_NET_PRIVATE_KEY +WALLET_ADDR
~/c/work/filo/file/filecoin-pin 303-validate…-descendants *3 !1 ?23
✔ ❯ npx filecoin-pin
Usage: filecoin-pin [options] [command]
IPFS Pinning Service with Filecoin storage via Synapse
SDK foobar123
Options:
-V, --version output the version number
-v, --verbose verbose output
--no-update-check skip check for updates
-h, --help display help for command
Commands:
server [options] Start the IPFS Pinning Service API server
payments Manage payment setup for Filecoin Onchain Cloud
data-set|dataset Inspect data sets managed through Filecoin Onchain Cloud
import [options] <file> Import an existing CAR file to Filecoin via Synapse
add [options] <path> Add a file or directory to Filecoin via Synapse (creates UnixFS CAR)
rm [options] Remove a Piece from a DataSet
| # Commands for building Synapse | ||
| # Commands for adjusting filecoin-pin to use local Synapse |
There was a problem hiding this comment.
TODO: I need to fill this in
| If you want to quickly try out changes via CLI that were made in `filecoin-pin` only (i.e., not relying on unpublished changes in `synapse-sdk`): | ||
|
|
||
| ```bash | ||
| npx tsx src/cli.ts $COMMAND |
There was a problem hiding this comment.
this works for non-built versions, or you can use bun, or you can run npm run build && npx filecoin-pin in the package root
This includes some info I would have wanted when working on FilOzone/filecoin-services#380 (or it includes the headers I wish were there).