Git Product home page Git Product logo

xrp-commander's Introduction

XRP Commander

A command-line tool for doing XRP stuff

This is a wrapper around ripple-lib with a focus on adding functions that are generally pretty complex.

The goal is to add commands over time as needed and have a consistent user experience so it's easy to install and use this tool without always copying and pasting XRP secrets etc.

Install

npm install -g xrp-commander

Run

xrp <command> <subcommand>

Some config is read from ENV variables if available:

Var Description Default
XRP_ADDRESS The XRP address to use when submitting transactions None
XRP_SECRET The XRP secret to use when submitting transactions None
XRP_SERVER The URL of the rippled server to connect to wss://s1.ripple.com:443

Security

Commands that require an XRP secret will look for this in ENV vars first then prompt for it if it's not found. The XRP address will be derived from the secret if not provided.

Commands

Inspired by git and npm commands are grouped by feature and then function (e.g. escrow create). Executing a command with no parameters will output details on what is required.

Escrow

xrp escrow <create|release>

Transactions

xrp tx <find>

Account Settings

xrp account <domain|emailHash>

Contributing

This lib has been intentionally designed for easy contribution. To add a command simply submit a PR that adds a new file in the ./src/commands/ folder.

If you want to to discuss the proposed new feature beforehand log an issue.

TODOs

  • Add some tests

  • Document commands better

  • Improve interactive input collection and use of named params

  • Auto-generate docs from command definitions

  • Setup CI

  • Commands

    • Escrow (Cancel)
    • Payments
    • Payment Channels (Create/Monitor/Cleanup etc)

xrp-commander's People

Contributors

adrianhopebailie avatar nixer89 avatar

Watchers

James Cloos 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.