{"id":13710180,"url":"https://github.com/aeternity/aepp-cli-js","last_synced_at":"2025-04-10T06:10:09.294Z","repository":{"id":33434581,"uuid":"155216316","full_name":"aeternity/aepp-cli-js","owner":"aeternity","description":"Command line interface for the æternity blockchain","archived":false,"fork":false,"pushed_at":"2025-04-08T15:38:07.000Z","size":2308,"stargazers_count":7,"open_issues_count":14,"forks_count":6,"subscribers_count":5,"default_branch":"develop","last_synced_at":"2025-04-10T01:41:13.268Z","etag":null,"topics":["aeternity","blockchain","cli","devtools"],"latest_commit_sha":null,"homepage":"https://docs.aeternity.com/developer-documentation/aepp-cli-js","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aeternity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-10-29T13:26:40.000Z","updated_at":"2025-04-08T15:32:17.000Z","dependencies_parsed_at":"2023-01-15T00:54:18.961Z","dependency_job_id":"5085886c-6e8d-44e2-968c-e7771df23a22","html_url":"https://github.com/aeternity/aepp-cli-js","commit_stats":{"total_commits":338,"total_committers":12,"mean_commits":"28.166666666666668","dds":0.4023668639053254,"last_synced_commit":"7deddb94ed48fb7410ddbda6890e2311cb4c3de2"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeternity%2Faepp-cli-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeternity%2Faepp-cli-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeternity%2Faepp-cli-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aeternity%2Faepp-cli-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aeternity","download_url":"https://codeload.github.com/aeternity/aepp-cli-js/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248166925,"owners_count":21058481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aeternity","blockchain","cli","devtools"],"created_at":"2024-08-02T23:00:52.806Z","updated_at":"2025-04-10T06:10:09.282Z","avatar_url":"https://github.com/aeternity.png","language":"JavaScript","funding_links":[],"categories":["Development"],"sub_categories":["CLIs, other Plugins \u0026 Libraries"],"readme":"# aepp-cli-js\n\nCommand Line Interface for the æternity blockchain.\n\n## Installation\n\nYou can install `aecli` using your preferred tool (`yarn` or `npm`). Here's an `npm` example\n\n```\n$ npm install --global @aeternity/aepp-cli\n```\n\n## Quick start\n\nLet's ensure that CLI installed correctly by running `$ aecli`. It will show the available commands as below.\n\n\u003c!-- ROOT-HELP-BEGIN --\u003e\n\n```\n$ aecli\nUsage: aecli [options] [command]\n\nOptions:\n  -V, --version                                 output the version number\n  -h, --help                                    display help for command\n\nCommands:\n  account                                       handle wallet operations\n  spend [options] \u003cwallet\u003e \u003creceiver\u003e \u003camount\u003e  send coins to another account or contract\n  name                                          manage AENS names\n  contract                                      contract interactions\n  oracle                                        interact with oracles\n  chain                                         make a request to the node\n  inspect [options] \u003cidentifier\u003e                get details of a node entity\n  tx                                            generate transactions to sign and submit manually\n  config [options]                              print the current sdk configuration\n  select-node [nodeUrl]                         specify node to use in other commands\n  select-compiler [compilerUrl]                 specify compiler to use in other commands\n  help [command]                                display help for command\n```\n\n\u003c!-- ROOT-HELP-END --\u003e\n\n\u003e To read documentation of other commands and sub-commands, you can append `--help`. For example, type `aecli account --help` to get a list of commands available in `account` module.\n\nThe next step is to create a wallet to use in other commands:\n\n\u003c!-- WALLET-CREATE-BEGIN --\u003e\n\n```\n$ aecli account create ./wallet.json\nAddress  ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E\nPath     /path/to/wallet.json\n```\n\n\u003c!-- WALLET-CREATE-END --\u003e\n\nYou need to send some coins to the created wallet.\n\n\u003e On testnet you can do that using [faucet]. Switch to testnet using `$ aecli select-node`.\n\n[faucet]: https://faucet.aepps.com/\n\nRun `$ aecli inspect \u003cwallet address\u003e` to ensure that it got coins.\n\n\u003c!-- INSPECT-BEGIN --\u003e\n\n```\n$ aecli inspect ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E\nAccount ID       ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E\nAccount balance  10000ae\nAccount nonce    0\nNo pending transactions\n```\n\n\u003c!-- INSPECT-END --\u003e\n\nAt the last step, we will send our coins to another account:\n\n\u003c!-- SPEND-BEGIN --\u003e\n\n```\n$ aecli spend ./wallet.json ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT 42ae\nTransaction mined\nTransaction hash   th_2muLsbZeFaVJ3tePTnLqobPhxBzwFsm1zUv8sjgMX4LKuevX2T\nBlock hash         mh_dnoULQWpiRtcrntd5yJPUxcu7YrTu18xZ1e9EC2b8prKdShME\nBlock height       2 (about now)\nSignatures         [\"sg_SG5uW5KEGiy5iG1cCkKq4VEdpyvewcW4NjVf4vj2ZoCiap5iB7UQoknWpyWsD4FkziBuGPE88zwXemq3ZvPrdzNtXtKuD\"]\nTransaction type   SpendTx (ver. 1)\nSender address     ak_21A27UVVt3hDkBE5J7rhhqnH5YNb4Y1dqo4PnSybrH85pnWo7E\nRecipient address  ak_AgV756Vfo99juwzNVgnjP1gXX1op1QN3NXTxvkPnHJPUDE8NT\nAmount             42ae\nPayload            ba_Xfbg4g==\nFee                0.00001684ae\nNonce              1\nTTL                4 (about now)\n```\n\n\u003c!-- SPEND-END --\u003e\n\nFind out more in the [user guide](./user-guide.md).\n\n## Resources\n\n- [User guide](./user-guide.md)\n- [Changelog](./CHANGELOG.md)\n- [Contributor guide](./contributor-guide.md)\n\n## Commands reference\n\n\u003c!-- REFERENCE-TOC-BEGIN --\u003e\n\n- `account`\n  - [`sign`](./reference.md#sign) — sign a transaction using wallet\n  - [`sign-message`](./reference.md#sign-message) — sign a personal message using wallet\n  - [`verify-message`](./reference.md#verify-message) — check if message was signed by address\n  - [`address`](./reference.md#address) — get wallet address and optionally secret key\n  - [`create`](./reference.md#create) — create a wallet by a secret key or generate a new one\n- [`spend`](./reference.md#spend) — send coins to another account or contract\n- `name`\n  - [`full-claim`](./reference.md#full-claim) — claim an AENS name in a single command\n  - [`pre-claim`](./reference.md#pre-claim) — pre-claim an AENS name\n  - [`claim`](./reference.md#claim) — claim an AENS name (requires pre-claim)\n  - [`bid`](./reference.md#bid) — bid on name in auction\n  - [`update`](./reference.md#update) — update a name pointer\n  - [`extend`](./reference.md#extend) — extend name TTL\n  - [`revoke`](./reference.md#revoke) — revoke an AENS name\n  - [`transfer`](./reference.md#transfer) — transfer a name to another account\n- `contract`\n  - [`compile`](./reference.md#compile) — compile a contract to get bytecode\n  - [`encode-calldata`](./reference.md#encode-calldata) — encode calldata for contract call\n  - [`decode-call-result`](./reference.md#decode-call-result) — decode contract call result\n  - [`call`](./reference.md#call) — execute a function of the contract\n  - [`deploy`](./reference.md#deploy) — deploy a contract on the chain\n- `oracle`\n  - [`create`](./reference.md#create-1) — register current account as oracle\n  - [`extend`](./reference.md#extend-1) — extend oracle's time to leave\n  - [`create-query`](./reference.md#create-query) — create an oracle query\n  - [`respond-query`](./reference.md#respond-query) — respond to an oracle query\n- `chain`\n  - [`top`](./reference.md#top) — query the top key/micro block of the chain\n  - [`status`](./reference.md#status) — query node version, network id, and related details of the selected node\n  - [`ttl`](./reference.md#ttl) — get relative TTL by absolute TTL\n  - [`play`](./reference.md#play) — prints blocks from top until condition\n  - [`broadcast`](./reference.md#broadcast) — send signed transaction to the chain\n- [`inspect`](./reference.md#inspect) — get details of a node entity\n- `tx`\n  - [`spend`](./reference.md#spend-1) — build spend transaction\n  - [`name-preclaim`](./reference.md#name-preclaim) — build name preclaim transaction\n  - [`name-claim`](./reference.md#name-claim) — build name claim transaction\n  - [`name-update`](./reference.md#name-update) — build name update transaction\n  - [`name-transfer`](./reference.md#name-transfer) — build name transfer transaction\n  - [`name-revoke`](./reference.md#name-revoke) — build name revoke transaction\n  - [`contract-deploy`](./reference.md#contract-deploy) — build contract deploy transaction\n  - [`contract-call`](./reference.md#contract-call) — build contract call transaction\n  - [`oracle-register`](./reference.md#oracle-register) — build oracle register transaction\n  - [`oracle-extend`](./reference.md#oracle-extend) — build oracle extend transaction\n  - [`oracle-post-query`](./reference.md#oracle-post-query) — build oracle post query transaction\n  - [`oracle-respond`](./reference.md#oracle-respond) — build oracle respond transaction\n  - [`verify`](./reference.md#verify) — verify transaction using node\n- [`config`](./reference.md#config) — print the current sdk configuration\n- [`select-node`](./reference.md#select-node) — specify node to use in other commands\n- [`select-compiler`](./reference.md#select-compiler) — specify compiler to use in other commands\n\n\u003c!-- REFERENCE-TOC-END --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeternity%2Faepp-cli-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faeternity%2Faepp-cli-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faeternity%2Faepp-cli-js/lists"}