Closed
Conversation
FilOzzy
added
team/filecoin-pin
BigLep
force-pushed
the
biglep/add-development.md
branch
from
894eea5 to
26634c5
Compare
Member
Author
|
@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.
This was referenced Jan 12, 2026
rvagg
reviewed
Jan 13, 2026
Co-authored-by: Rod Vagg <rod@vagg.org>
SgtPooki
reviewed
Jan 21, 2026
Collaborator
SgtPooki
left a comment
SgtPooki
left a comment
There was a problem hiding this comment.
leaving some comments, will come back to fix
Comment on lines
+20
to
+23
| # 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 |
Collaborator
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
Comment on lines
+77
to
+78
| # Commands for building Synapse | ||
| # Commands for adjusting filecoin-pin to use local Synapse |
Collaborator
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 |
Collaborator
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
rvagg
added a commit
that referenced
this pull request
Apr 8, 2026
rvagg
added a commit
that referenced
this pull request
Apr 8, 2026
Member
Author
|
Closing in favor of #408 |
rvagg
added a commit
that referenced
this pull request
Apr 9, 2026
* chore(docs): add development docs Closes: #300 * fixup! chore(docs): add development docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This includes some info I would have wanted when working on FilOzone/filecoin-services#380 (or it includes the headers I wish were there).