Giter VIP home page Giter VIP logo

ctl's Introduction

Super Protocol Publisher CLI

A tool for publishing values in a secure and reliable way.

Setup

  1. Follow instructions to setup Decentralized Cloud Storage providers: StorJ

  2. Install dependencies:

    npm i
    
  3. Run help in dev mode to see available commands:

    npm run dev help
    

Building

upload and download commands supported only on MacOS and Linux and requires to make build on the same system as the target platform

Linux

Build in docker (recommended):

cd linux_builder && ./build.sh && cd ..

Can be run on any os with Docker support.
Result will be saved at ./dist/spctl-linux

Build on native os (linux only):

npm run build:linux

IMPORTANT: to make upload and download commands works correctly, requires to make this build on Linux only
Result will be saved at ./dist/spctl

MacOS

npm run build:mac

IMPORTANT: to make upload and download commands works correctly, requires to make this build on MacOS only
Result will be saved at ./dist/spctl

Develop and Release

Before making a release, please decide what version tag this release should have - major, minor or patch. Then create a new release/vX.X.X branch with new version. Then run one of the next commands: npm run patch:beta or npm run minor:beta or npm run major:beta. This command will make commit, create new tag and push all of this to remote. Then you need to make PR to master and merge it with Rebase and Merge after approve. Then go the Releases Page and create new release with the name as new tag.

Commands

npm run build – compiles typescript with tcs.
npm run build:linux – builds a linux binary file ready for distribution
npm run build:macos – builds a macos binary file ready for distribution
npm run dev -- [command] – runs command in dev mode
npm run prettier – runs code auto formatting

Dependencies

  • NodeJS v17.4.0
  • NPM v8.3.1

ctl's People

Contributors

0xdm1try avatar agentrx avatar alekns avatar alexandr22022000 avatar ametelnikov avatar idris0v avatar ishmelev-sp avatar ishmelev23 avatar marchuk-vlad avatar marchukv avatar villain88 avatar vkapicyn avatar yakovlevalexander avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.