Skip to content

Commit

Permalink
Add readme for aptos-cli tool
Browse files Browse the repository at this point in the history
  • Loading branch information
kent-white authored and aptos-bot committed Apr 19, 2022
1 parent dcf805c commit c08f8be
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
19 changes: 18 additions & 1 deletion crates/aptos/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
### Aptos Tool
# Aptos CLI Tool

`aptos` is designed to be a single interface tool for debugging, development, and node operation.


## Set up
With Cargo:
1. Ensure you have `cargo` [installed](https://doc.rust-lang.org/cargo/getting-started/installation.html)
2. Directly install from source: `cargo install --git https://github.com/aptos-labs/aptos-core.git aptos`
3. Use `aptos` command

## Usage

```
account CLI tool for interacting with accounts
help Print this message or the help of the given subcommand(s)
init Tool to initialize current directory for the aptos tool
move CLI tool for performing Move tasks
op CLI tool for performing operational tasks
```
2 changes: 1 addition & 1 deletion crates/aptos/src/account/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ use clap::Subcommand;
pub mod create;
pub mod list;

/// Command to create a new account on-chain
/// CLI tool for interacting with accounts
///
#[derive(Debug, Subcommand)]
pub enum AccountTool {
Expand Down

0 comments on commit c08f8be

Please sign in to comment.