Starling

A terminal window showing the Starling Filecoin application.

This guide will quickly set up Starling on your computer.

Prerequisites

You need to have a couple of things installed before you can interact with Starling:

  1. Lotus.
  2. NodeJS version 12.19 or higher.

Steps

  1. Ensure that the Lotus daemon is running, and has fully synced.

  2. In a new terminal window, get your Lotus API token and endpoint with:

    lotus auth api-info --perm admin
    

    This will output something like:

    FULLNODE_API_INFO=eyJhbGcabdjwieusyiIsInR5cCI6IkpXVCJ9.eyJBbGxvdyI6WyJyZWFkIiwid3JpdGUiLCJzaWduIiwdj3isu2938X0.tmdXnxUflc8nhghfjiwo2l1o9T1QwT0jLskdEV5cYEc:/ip4/127.0.0.1/tcp/1234/http
    
  3. Clone the Starling repository:

    git clone https://github.com/filecoin-project/starling
    
  4. Move into the starling directory and install the dependencies:

    cd starling
    npm install
    sudo npm link
    
  5. Configure Starling settings:

    starling config
    

Run Starling

  1. Store a single file run:

    starling store full/path/to/file
    
  2. Store a folder run:

    starling store full/path/to/folder
    
  3. Launch the interactive monitoring interface:

    starling monitor
    

Check the official documentation for a more in-depth look into what Starling can do.