Skip to content

Commit

Permalink
Fix CLI section
Browse files Browse the repository at this point in the history
  • Loading branch information
@d0cd
d0cd committed Feb 18, 2025
1 parent 52cd401 commit bda39ac
Show file tree
Hide file tree
Showing 3 changed files with 153 additions and 106 deletions.
253 changes: 149 additions & 104 deletions documentation/cli/00_overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,88 +4,107 @@ title: The Leo Command Line Interface
sidebar_label: Overview
---

The Leo CLI is a command line interface tool that comes equipped with the Leo compiler.

## Installation

[**Install Leo**](01_installation.md)

## Global Flags

* `-d`, `--debug` - Enables debugging mode
* `-h`, `--help` - Prints help information
* `-v`, `--version` - Prints version information

## List of Commands:
The Leo CLI is a command line interface tool that comes equipped with the Leo compiler. It contains a number of helpful

:::tip
You can print the list of commands by running `leo --help`
:::

## Commands

* [`account`](#leo-account) - Create a new Aleo account, sign and verify messages.
* [`new`](#leo-new) - Create a new Leo project in a new directory.
* [`build`](#leo-build) - Compile the current project.
* [`deploy`](#leo-deploy) - Generate proving and verifying keys and produce a transaction contianing the deployment.
* [`run`](#leo-run) - Run a program without producing a proof.
* [`execute`](#leo-execute) - Execute a program and produce a transaction containing a proof.
* [`deploy`](#leo-deploy) - Generate proving and verifying keys and produce a transaction contianing the deployment.
* [`debug`](#leo-debug) - Run the interactive debugger in the current package.
* [`query`](#leo-query) - Retrieve metadata and state from the network.
* [`add`](#leo-add) - Add a new on-chain or local dependency to the current project.
* [`remove`](#leo-remove) - Remove a dependency from the current project.
* [`clean`](#leo-clean) - Clean the build and output artifacts.
* [`update`](#leo-update) - Update to the latest version of Leo.

---


## `leo account`

[Back to Top](#commands)

To create a new Aleo account, run:

```bash
leo account new

Private Key APrivateKey1zkp...
View Key AViewKey1...
Address aleo1...
```

:::warning
We urge you to exercise caution when managing your private keys. `leo account` cannot be used to recover lost keys.
:::

## `leo example`
To import an existing Aleo account, run:

To list all available example programs, run:
```bash
leo account import {$PRIVATE_KEY}
```
leo example

# Output:
To create a new account and save it to your `.env` file, run:

Create a new Leo example package in a new directory
```bash
leo account new --write
````

Usage: leo example [OPTIONS] <COMMAND>
`leo account` has a number of additional subomcommands. To list all options, run:

```
leo account --help

# Output:
Create a new Aleo account, sign and verify messages

Usage: leo account [OPTIONS] <COMMAND>

Commands:
lottery A public lottery program
tictactoe A standard tic-tac-toe game program
token A transparent & shielded custom token program
help Print this message or the help of the given subcommand(s)
new Generates a new Aleo account
import Derive an Aleo account from a private key
sign Sign a message using your Aleo private key
verify Verify a message from an Aleo address
help Print this message or the help of the given subcommand(s)

Options:
-d Print additional information for debugging
-q Suppress CLI output
--path <PATH> Optional path to Leo program root folder
--home <HOME> Optional path to aleo program registry.
-h, --help Print help
```
To create a new Leo package from an example program, run:
```bash
leo example {$NAME}
```
To learn more about how to use `leo account` to sign and verify messages, check out [**Sign and Verify**](03_signing.md).
## `leo new`
To create a new package, run:
[Back to Top](#commands)
To create a new project, run:
```bash
leo new {$NAME}
```

Valid package names are snake_case: lowercase letters and numbers separated by underscores.
This command will create a new directory with the given package name.
The new package will have a directory structure as follows:
Valid project names are snake_case: lowercase letters and numbers separated by underscores.
This command will create a new directory with the given project name.

See [Project Layout](../language/01_layout.md) for more details .

```bash
package/
├── .env # Your program environment
├── program.json # Your program manifest
├── README.md # Your program description
├── build/
└── src/
└── main.leo # Your program file
```

## `leo build`

[Back to Top](#commands)

To compile your program into Aleo Instructions and verify that it builds properly, run:
```bash
leo build
Expand All @@ -109,7 +128,23 @@ This will populate the directory `build/` (creating it if it doesn't exist) with
Leo ✅ Compiled 'main.leo' into Aleo instructions
```


## `leo deploy`
[Back to Top](#commands)
:::tip
Use this command to deploy a program to the Aleo network. This requires having a funded account.
:::

To deploy the project in the current working directory.
```bash
leo deploy // Defaults to using key information in `.env`, and deploys to `testnet3` via endoint `http://api.explorer.provable.com/v1`.
leo deploy --endpoint "{$ENDPOINT}" --private-key "{$PRIVATE_KEY}" // To deploy using custom private key, to a custom endpoint (e.g. local devnet `http://0.0.0.0:3030`).
```

See [Deploy](01_deploying.md) for more details.

## `leo run`
[Back to Top](#commands)
:::tip
Use this command to run your program before [**executing**](#leo-execute) it.
:::
Expand All @@ -135,6 +170,7 @@ This command does not synthesize the program circuit or generate proving and ver
```

## `leo execute`
[Back to Top](#commands)
:::tip
Use this command to execute your program and generate a transaction object.
:::
Expand All @@ -161,114 +197,123 @@ This command synthesizes the program circuit and generates proving and verifying
Leo ✅ Executed 'hello.aleo/main' (in "/hello/build")
```
See [Execute](./02_executing.md) for more details.
## `leo debug`
[Back to Top](#commands)
To start the interactive debugger, run `leo debug` in a Leo project.
```bash
> leo debug
Leo ✅ Compiled sources for 'workshop'
This is the Leo Interpreter. Try the command `#help`.
? Command? ›
```
See [Debugging](./../testing/02_debugger.md) for more details.
## `leo query`
[Back to Top](#commands)
Use `leo query` to get data from a network supporting the canonical `snarkOS` endpoints.
```bash
Query live data from the Aleo network
Usage: leo query [OPTIONS] <COMMAND>
Commands:
block Query block information
transaction Query transaction information
program Query program source code and live mapping values
stateroot Query the latest stateroot
committee Query the current committee
mempool Query transactions and transmissions from the memory pool
peers Query peer information
help Print this message or the help of the given subcommand(s)
Options:
-d Print additional information for debugging
-e, --endpoint <ENDPOINT> Endpoint to retrieve network state from. Defaults to entry in `.env`.
-n, --network <NETWORK> Network to use. Defaults to entry in `.env`.
-q Suppress CLI output
--path <PATH> Path to Leo program root folder
--home <HOME> Path to aleo program registry
-h, --help Print help
```
## `leo add`
[Back to Top](#commands)
:::tip
Use this command to add a dependency to your program. This is a precursor to being able to import a program inside the leo source code file.
:::
To add an already deployed program as a project dependency.
The command can be used to add an already deployed program as a project dependency.
`{$PROGRAM}` should be the name of the program to add as a dependency.
```bash
leo add {$PROGRAM} // {$NETWORK} defaults to `testnet`.
leo add -n {$NETWORK} {$PROGRAM} // To pull from a custom network.
```
To add a local Leo program as a project dependency.
`{$PATH}` should be the relative path to the dependency project directory.
The command can be used to add a local Leo program as a project dependency.
`{$PATH}` should be the relative path to the project directory.
```bash
leo add -l {$PATH} {$PROGRAM}
```
## `leo deploy`
:::tip
Use this command to deploy a program to the Aleo network. This requires having a funded account.
:::
See [Dependency Management](./04_dependencies.md) for more details.
## `leo remove`
[Back to Top](#commands)
Removes the dependency, local or remote, from the project.
To deploy the project in the current working directory.
```bash
leo deploy // Defaults to using key information in `.env`, and deploys to `testnet3` via endoint `http://api.explorer.provable.com/v1`.
leo deploy --endpoint "{$ENDPOINT}" --private-key "{$PRIVATE_KEY}" // To deploy using custom private key, to a custom endpoint (e.g. local devnet `http://0.0.0.0:3030`).
leo remove credits.aleo
```
See [Dependency Management](./04_dependencies.md) for more details.
## `leo clean`
[Back to Top](#commands)
To clean the build directory, run:
```bash
leo clean
```
```bash title="console output:"
Leo cleaned the build directory (in "/build/")
Leo 🧹 Cleaned the outputs directory (in "...")
Leo 🧹 Cleaned the build directory (in "...")
```
## `leo update`
[Back to Top](#commands)
To download and install the latest Leo version run:
```bash
leo update
```
```bash title="console output:"
Checking target-arch... x86_64-apple-darwin
Checking current version... v1.8.3
Checking latest released version... v1.8.3
Updating Leo is on the latest version 1.9.0
```
## `leo account`
To create a new Aleo account, run:
```bash
leo account new
# Output:
Private Key APrivateKey1zkp...
View Key AViewKey1...
Address aleo1...
```
To import an existing Aleo account, run:
```bash
leo account import {$PRIVATE_KEY}
```
To create a new account and save it to your .env file, run:
```bash
leo account new --write
````
To list all options
```
leo account --help
# Output:
Create a new Aleo account, sign and verify messages
Usage: leo account [OPTIONS] <COMMAND>
Commands:
new Generates a new Aleo account
import Derive an Aleo account from a private key
sign Sign a message using your Aleo private key
verify Verify a message from an Aleo address
help Print this message or the help of the given subcommand(s)
Options:
-d Print additional information for debugging
-q Suppress CLI output
--path <PATH> Optional path to Leo program root folder
--home <HOME> Optional path to aleo program registry.
-h, --help Print help
```
### `leo example`
[Back to Top](#commands)
:::warning
`leo example` has been deprecated and will no longer be supported.
:::
2 changes: 2 additions & 0 deletions documentation/cli/03_signing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Sign and Verify
sidebar_label: Sign and Verify
---

In addition to creating accounts, `leo account` can be used to sign data and verify signatures. This can be useful for a particular class of applications that rely on signed data as input.

## `leo account sign`

The `leo account sign` command enables developers and users to create cryptographic signatures using an Aleo private key. These signatures can be verified within leo using the [`signature::verify`](../leo/04_operators.md#signatureverify) function or with the `leo account verify` command.
Expand Down
4 changes: 2 additions & 2 deletions documentation/resources/03_projects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Built on Leo
sidebar_label: Built on Leo
---

<!--TODO:-->



Coming soon!

0 comments on commit bda39ac

Please sign in to comment.