Skip to content
Demo storage client for archival video data
JavaScript
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci feat: sprint 1 Sep 9, 2019
commands feat: add get command (#16) Feb 19, 2020
constants feat: add get command (#16) Feb 19, 2020
db feat: add get command (#16) Feb 19, 2020
utils feat: sprint 3 (#8) Oct 7, 2019
.eslintrc.js feat: sprint 1 Sep 9, 2019
.gitignore feat: sprint 1 Sep 9, 2019
.prettierrc feat: sprint 1 Sep 9, 2019
LICENSE-APACHE licenses Sep 23, 2019
LICENSE-MIT licenses Sep 23, 2019
README.md Update README.md Oct 7, 2019
index.js feat: sprint 3 (#8) Oct 7, 2019
package-lock.json feat: sprint 4 (#11) Jan 10, 2020
package.json feat: sprint 4 (#11) Jan 10, 2020

README.md

Starling

A command-line interface for simplified, coordinated, decentralized storage on the Filecoin network. This is a work in progress and is not yet 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

API Address Config

The default API Address is localhost, in cases where Starling and the filecoin node are on the same machine. In order to connect to a remote filecoin node, create a .env file in the root directory of the project and insert the API Adress as such:

apiAddr='/ip4/<Filecoin Node IP Address>/tcp/3453/'

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

// up/down keys: scroll through the list
// ^H: hide/show queued files
// ^F: filter all files

Generate a CSV report of all files stored

// outputs file in the working directory
> starling list

// outputs file in the specified directory
> starling list <path>

Generate a CSV report of file fixity

// outputs file in the working directory
> starling verify

// outputs file in the specified directory
> starling verify <path>

Retry uploading the failed jobs

> starling retry

Output the version number

> starling --version | -v

Output usage information

> starling --help | -h | help

> starling [command] --help
You can’t perform that action at this time.