Publishing a Substreams Package

Reading time: 1 min

Learn how to publish a Substreams package to the Substreams Registry.

A Substreams package is a precompiled binary file that defines the specific data you want to extract from the blockchain, similar to the mapping.ts file in traditional subgraphs.

• You must have the Substreams CLI installed.
• You must have a Substreams package (.spkg) that you want to publish.

1. In a command-line terminal, run substreams publish <YOUR-PACKAGE>.spkg.

2. If you do not have a token set in your computer, navigate to https://substreams.dev/me.

1. In the Substreams Registry, log in with your GitHub account.

2. Create a new token and copy it in a safe location.

1. Back in the Substreams CLI, paste the previously generated token.

2. Lastly, confirm that you want to publish the package.

That's it! You have succesfully published a package in the Substreams registry.

Visit Substreams to explore a growing collection of ready-to-use Substreams packages across various blockchain networks.