Table of content
- Table of content
- Quick Start
- More: Guides & Examples
- CLI - Command Line Client
- Change Log
1. Install SDK
A) Simple Usage: with
If you're using bundling/compilation techniques (eg.
webpack), please continue reading.
B) Advanced Usage: with
npm or similar
Add the latest
@aeternity/aepp-sdk release from npmjs.com to your project using one of these commands
# install using npm...or yarn or pnpmnpm i @aeternity/aepp-sdk
Note: To install a Pre-Release (latest
alpha version) using on the latest Node version, you have to install the package appending the
@next tag reference, or even use the
# symbol and the Repo URL to install a version coming from a specific branch.
# install the @next version of the SDKnpm i @aeternity/aepp-sdk@next# install the #develop version of the SDKnpm i https://github.com/aeternity/aepp-sdk-js#develop
Note : If you experience errors during the installation, you might need to install build tools for your OS.
Windows: Windows Build Tools
npm install -g windows-build-tools
Ubuntu / Debian: Build Essential
sudo apt-get update sudo apt-get install build-essential
Mac: Download Xcode from AppStore, then run
2. Create an Account
You can do many more things now, but you'll probably have to start with:
A) Using the Command Line
Create an account using the 💻 CLI
B) Using the SDK
const keypair = Cryptoconsoleconsole
3. Give yourself some AE tokens
To get yourself some AEs you can use the 🚰 Faucet Aepp. Just add your publicKey, and you'll immediately get some test tokens.
4. Import (a chosen Flavor)
Import the right flavor. For this example with get the
Universal flavor, which contains all the features of the SDK:
// Import Flavor
5. Play with Aetenity's blockchain features
// Use FlavorPromiseallNode url internalUrl
More: Guides & Examples
CLI - Command Line Client
To quickly test all of Aeternity's blockchain features from your Terminal, you can Install and use our NodeJS CLI by running:
npm i -g @aeternity/aepp-clito globally install the CLI
aecli --helpto get a list of possible commands
eg. Create an Account:
aecli account create testWhateverAccountName
For advanced use, to get a deeper understanding of the SDK or to contribute to its development, it is advised to read the Contributing Guidelines section.
We keep our Changelog up to date.
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.