Skip to content

docs: created DEVELOPMENT.md with some tips#300

Draft
BigLep wants to merge 4 commits intomasterfrom
biglep/add-development.md
Draft

docs: created DEVELOPMENT.md with some tips#300
BigLep wants to merge 4 commits intomasterfrom
biglep/add-development.md

Conversation

@BigLep
Copy link
Copy Markdown
Member

@BigLep BigLep commented Jan 9, 2026

This includes some info I would have wanted when working on FilOzone/filecoin-services#380 (or it includes the headers I wish were there).

@FilOzzy FilOzzy added team/filecoin-pin "Filecoin Pin" project is a stakeholder for this work. team/fs-wg FOC working group is a stakeholder for this work, and thus wants to track it on their project board. labels Jan 9, 2026
@FilOzzy FilOzzy added this to FOC Jan 9, 2026
@github-project-automation github-project-automation bot moved this to 📌 Triage in FOC Jan 9, 2026
@BigLep BigLep force-pushed the biglep/add-development.md branch from 894eea5 to 26634c5 Compare January 9, 2026 22:18
@BigLep BigLep requested a review from SgtPooki January 9, 2026 22:19
@BigLep
Copy link
Copy Markdown
Member Author

BigLep commented Jan 9, 2026

@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.

BigLep and others added 2 commits January 9, 2026 14:39
Added instructions for HTTP tracing on the CLI and clarified the importance of uploading unique data.
Co-authored-by: Rod Vagg <[email protected]>
@rjan90 rjan90 moved this from 📌 Triage to ⌨️ In Progress in FOC Jan 15, 2026
Copy link
Copy Markdown
Collaborator

@SgtPooki SgtPooki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@BigLep BigLep moved this from ⌨️ In Progress to 🐱 Todo in FOC Jan 22, 2026
@BigLep BigLep added this to the M4.2: mainnet GA milestone Feb 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team/filecoin-pin "Filecoin Pin" project is a stakeholder for this work. team/fs-wg FOC working group is a stakeholder for this work, and thus wants to track it on their project board.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

There is a way to see all HTTP calls

5 participants