
️⚠️ [WIP] aepp-cli-js
Command Line Interface for the æternity blockchain.
Disclaimer
This project is a work-in-progress and things might break. We aim to make our
pre-releases as stable as possible. Neverless it should not be taken as
production-ready. To catch up with even more edgy state of development please
check out the develop branch.
Installation
️⚠️ TODO: The package is not yet published, so you can only install it by cloning this project.
You can install this CLI
using your preferred tool (yarn
or npm
). Here's an npm
example
npm install --global @aeternity/aepp-cli
Local symlink to aecli
Run npm link
for linking aecli
name to aecli/bin/aecli.js
- Clone or copy the
aepp-cli-js
git repository into any place you like - Enter the folder and run
npm link
- Enter a new
bash
session and try aecli
command to see if everything is okay. - If you have any issue, open an
issue
in github
If you have problems linking, try also npm install
and then npm link
Usage Documentation
You can install, use and work on this CLI
tool, by following these instructions:
- Clone this repository
- With your terminal: enter in folder when the repo has been cloned
- Run
bin/aecli.js
to see the (following) available commands or run npm link
and use aecli
command
Usage: aecli [options] [command]
Options:
-V, --version output the version number
-h, --help output usage information
Commands:
chain Interact with the blockchain
inspect Get information on transactions, blocks,...
account Handle wallet operations
contract Compile contracts
name AENS system
crypto Crypto helpers
help [cmd] display help for [cmd]
- To read documentation of other commands and sub-commands, you can append
--help
. For example, type bin/aecli.js account --help
to get a list of account
's available sub-commands.
License
ISC License (ISC)
Copyright © 2018 aeternity developers
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.