This repository has been archived by the owner on Aug 2, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[docs] Update reference for various cleos commands - 2.1 #10403
Merged
Merged
Changes from 5 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
dc0d7f2
applied new command reference template
bobgt 9ec4efa
applied revised reference template
bobgt cc9f9e0
applied command ref template
bobgt bc4df47
applied new reference template
bobgt c5979bb
applied reference template
bobgt 50ebdc0
applied reference template
bobgt f5f4d2f
fix broken link and other edits on cleos create account ref :doc
669a78c
minor edits on cleos create key ref :doc
a79443f
minor edits on cleos create account ref :doc
f94272d
minor edits on cleos get transaction ref :doc
7cfdce0
minor edits on cleos wallet import ref :doc
155e463
minor edits on cleos wallet keys ref :doc
f3e12aa
minor edits on cleos net connect ref :doc
25450c5
minor edits on cleos net disconnect ref :doc
40542cb
minor edits on cleos net peers ref :doc
661e77c
minor edits on cleos net status ref :doc
969f415
fix the wallet import example
858c661
minor edits to cleos wallet import ref :doc
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,28 @@ | ||
## Command | ||
|
||
```ssh | ||
cleos create account [OPTIONS] creator name OwnerKey [ActiveKey | ||
``` | ||
|
||
**Where**: | ||
|
||
* [`OPTIONS`] = See **Options** in **Command Usage** section below | ||
* `creator` = The name of the existing account creating the new account | ||
* `name` = The name of the new account | ||
* `OwnerKey` = The owner public key or permission level for the new account | ||
* [`ActiveKey`]= See **Positionals** in **Command Usage** section below | ||
|
||
[[info | Note]] | ||
| The arguments and options enclosed in square brackets are optional. | ||
|
||
## Description | ||
Create a new account on the blockchain (assumes system contract does not restrict RAM usage) | ||
Use this command to create a new blockchain account on EOSIO. | ||
|
||
## Usage | ||
[[info | Note]] | ||
| This command assumes system contract does not restrict RAM usage. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this needs an explanation -> or a link to something explaining ram and accounts, and an accounts requirement for ram and the cost etc |
||
|
||
## Command Usage | ||
The following information shows the different positionals and options you can use with the cleos create account command: | ||
|
||
```console | ||
Usage: cleos create account [OPTIONS] creator name OwnerKey [ActiveKey] | ||
|
@@ -29,16 +50,14 @@ Options: | |
--delay-sec UINT set the delay_sec seconds, defaults to 0s | ||
``` | ||
|
||
## Command | ||
A set of EOSIO keys is required to create an account. The EOSIO keys can be generated by using `cleos create key`. | ||
## Requirements | ||
For prerequisites to successfully run this command, see the **Before you Begin** section of the [_How to Create a Blockchain Account_](../02_how-to-guides/how-to-create-an-account.md) guide. | ||
|
||
```sh | ||
cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA | ||
``` | ||
## Example Command | ||
|
||
## Output | ||
```console | ||
cleos create account inita tester EOS4toFS3YXEQCkuuw1aqDLrtHim86Gz9u3hBdcBw5KNPZcursVHq EOS7d9A3uLe6As66jzN8j44TXJUqJSK3bFjjEEqR4oTvNAB3iM9SA | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. does this need the where bit to explain the parameters - help explain the 2 public keys |
||
|
||
```json | ||
{ | ||
"transaction_id": "6acd2ece68c4b86c1fa209c3989235063384020781f2c67bbb80bc8d540ca120", | ||
"processed": { | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,55 +1,36 @@ | ||
## Command | ||
|
||
```sh | ||
cleos wallet import [OPTIONS] | ||
``` | ||
|
||
**Where** | ||
* [OPTIONS] = See Options in Command Usage section below. | ||
**Where**: | ||
|
||
**Note**: The arguments and options enclosed in square brackets are optional. | ||
* [`OPTIONS`] = See **Options** in **Command Usage** section below | ||
|
||
## Description | ||
Imports private key into wallet. This command will launch `keosd` if it is not already running. | ||
Use this command to imports private key into wallet. | ||
halsaphi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Command Usage | ||
The following information shows the different positionals and options you can use with the `cleos wallet import` command: | ||
|
||
### Positionals: | ||
- none | ||
### Options | ||
- `-h,--help` - Print this help message and exit | ||
- `-n, --name` _TEXT_ - The name of the wallet to import key into. | ||
- `--private-key` _TEXT_ - Private key in WIF format to import. | ||
```console | ||
Usage: cleos wallet import [OPTIONS] | ||
|
||
## Requirements | ||
* Install the currently supported version of `cleos` and `keosd`. | ||
[[info | Note]] | ||
| `Cleos` and `keosd` are bundled with the EOSIO software. [Installing EOSIO](../../00_install/index.md) will also install the `cleos` and `keosd` command line tools. | ||
|
||
## Examples | ||
1. Import a private key to the default wallet. The wallet must be **open** and **unlocked**. | ||
```shell | ||
cleos wallet import | ||
Options: | ||
-n,--name TEXT The name of the wallet to import key into | ||
--private-key TEXT Private key in WIF format to import | ||
``` | ||
## Requirements | ||
|
||
The command asks for the private key. Enter it. | ||
For prerequisites to run this command, see the **Before you Begin** section of the [_How to Import Private Key_](../02_how-to-guides/how-to-import-a-key.md) topic. | ||
|
||
```shell | ||
5KDNWQvY2seBPVUz7MiiaEDGTwACfuXu78bwZu7w2UDM9A3u3Fs | ||
``` | ||
## Example | ||
|
||
**Example Output** | ||
```shell | ||
private key: imported private key for: EOS5zG7PsdtzQ9achTdRtXwHieL7yyigBFiJDRAQonqBsfKyL3XhC | ||
``` | ||
|
||
2. Import a private key to a named wallet. The wallet must be `open` and `unlocked.` | ||
```shell | ||
cleos wallet import --name my_wallet --private-key 5KDNWQvY2seBPVUz7MiiaEDGTwACfuXu78bwZu7w2UDM9A3u3Fs | ||
```console | ||
cleos wallet import | ||
private key: | ||
``` | ||
**Where** | ||
`--name` my_wallet = Tells the `cleos wallet import` command to import the key to `my_wallet` | ||
`--private-key` 5KDNWQvY2seBPVUz7MiiaEDGTwACfuXu78bwZu7w2UDM9A3u3Fs = Tells the `cleos wallet import` command the private key to import | ||
|
||
**Example Output** | ||
```shell | ||
imported private key for: EOS5zG7PsdtzQ9achTdRtXwHieL7yyigBFiJDRAQonqBsfKyL3XhC | ||
```console | ||
private key: imported private key for: EOS8FBXJUfbANf3xeDWPoJxnip3Ych9HjzLBr1VaXRQFdkVAxwLE7 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing last ]