Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 1.28 KB

README.md

File metadata and controls

85 lines (56 loc) · 1.28 KB

Starling

A command-line interface for simplified, coordinated, decentralized storage on the Filecoin network. This is a work in progress – MVP ships October 5th, and this code is not production-ready. Use at your own risk.

      .. .
     .... ..
  ...... .. ... . .
    . ... ....... ... ..
         .... .. .. ....
              .........

Development

To run locally

> npm install

During development it’s convenient to make the symlink on our path point to the index.js we’re actually working on, using npm link.

> npm link

Test by running

> starling <command>

database

Starling uses an sqlite3 database. The db is created in HOME/.starling/starling.db

Logs

Logs are located in HOME/.starling/logs/starling.log

Commands

Modify the config file HOME/.starling/config.json

> starling config

Store a single file

> starling store path/to/file.jpg

Store a folder

> starling store path/to/folder

Launch interactive monitoring interface

> starling monitor

Generate CSV of all files stored

> starling list

Output the version number

> starling --version | -v

Output usage information

> starling --help | -h | help