Skip to content

Commit a30826d

Browse files
docs: readme enhancement
1 parent bdb5685 commit a30826d

File tree

2 files changed

+69
-21
lines changed

2 files changed

+69
-21
lines changed

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
# Hello World
1+
# 🤖 iApp Generator
22

3-
To get started with the `iapp` CLI and create your "Hello World" application,
4-
follow these steps:
5-
6-
[iapp CLI README](./cli/README.md)
7-
8-
## Architecture of the project
3+
## What is the iApp Generator?
94

10-
This is a monorepo repository
5+
iApp Generator (iExec Application Generator) is a CLI tool to create, test, and
6+
deploy iExec Applications (iApps) that run in a Trusted Execution Environment
7+
(TEE). It simplifies the process of building decentralized, confidential
8+
applications without requiring deep knowledge of confidential computing
9+
technologies. With the iApp Generator, you can:
1110

12-
```
13-
.
14-
├── api
15-
├── cli
16-
```
11+
- Create a basic application structure ready to run on a decentralized worker in
12+
a TEE.
13+
- Test your application locally in Debug Mode, enabling fast iteration and
14+
troubleshooting.
15+
- Deploy your iApp as a confidential application on the iExec protocol.
1716

18-
### Simple diagram
19-
20-
![Simple architecture diagram](quick-archi-diagram.png)
21-
22-
### More detailed diagram
17+
To get started with the `iapp` CLI and create your "Hello World" application,
18+
follow these steps:
2319

24-
![Detailed architecture diagram](archi-diagram.png)
20+
[iapp CLI README](./cli/README.md)

cli/README.md

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,19 +102,26 @@ Options:
102102
Command:
103103

104104
```sh
105-
iapp deploy
105+
iapp deploy [--chain <input>]
106106
```
107107

108108
Description: Deploy your iApp on the iExec protocol in debug mode.
109109

110+
Options:
111+
112+
- use `--chain` Specify the blockchain on which the iApp will be deployed (overrides defaultChain configuration which is `bellecour`). Possible values are `bellecour|arbitrum-sepolia-testnet|arbitrum-mainnet`
113+
114+
> [!IMPORTANT]
115+
> To use a chain other than `bellecour`, you must pass (or set in your system) `EXPERIMENTAL_NETWORKS=true` before the `iApp` command.
116+
110117
---
111118

112119
### `run`
113120

114121
Command:
115122

116123
```sh
117-
iapp run <iApp-address> [--args <input>] [--protectedData <protectedData-address>] [--inputFile <url...>]
124+
iapp run <iApp-address> [--args <input>] [--protectedData <protectedData-address>] [--inputFile <url...>] [--chain <input>]
118125
```
119126

120127
Description: Run your deployed iApp. Provide the address of your iApp
@@ -135,3 +142,48 @@ Options:
135142
[protected data](https://protocol.docs.iex.ec/for-developers/technical-references/application-io#protected-data),
136143
include the `--protectedData` option followed by the address of the protected
137144
data.
145+
- use `--chain` Specify the blockchain on which the iApp will be deployed (overrides defaultChain configuration which is `bellecour`). Possible values are `bellecour|arbitrum-sepolia-testnet|arbitrum-mainnet`
146+
147+
> [!IMPORTANT]
148+
> To use a chain other than `bellecour`, you must pass (or set in your system) `EXPERIMENTAL_NETWORKS=true` before the `iApp` command.
149+
150+
---
151+
152+
### `debug`
153+
154+
Command:
155+
156+
```sh
157+
iapp debug <taskId>
158+
```
159+
160+
Description: Retrieve detailed execution logs from worker nodes for a specific task.
161+
162+
---
163+
164+
### `mock`
165+
166+
Command:
167+
168+
```sh
169+
iapp mock <inputType>
170+
```
171+
172+
Description: Create a mocked input for test.
173+
174+
---
175+
176+
### `wallet`
177+
178+
Command:
179+
180+
```sh
181+
iapp wallet <action>
182+
```
183+
184+
Description: Manage wallet.
185+
186+
Options for `<action>` :
187+
188+
- `import` import a new wallet by providing a private key.
189+
- `select` select a wallet from your personnal keystore.

0 commit comments

Comments
 (0)