Skip to content

fix: cli iapp commands #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2025
Merged

fix: cli iapp commands #77

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80a8d49
fix(docs): update command usage and descriptions in iApp generator guide
Le-Caignec Oct 9, 2025
6c942f4
fix(docs): update blockchain network options and input type requireme…
Le-Caignec Oct 9, 2025
4bb5577
Apply suggestion from @Copilot
Le-Caignec Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 8 additions & 20 deletions src/references/iapp-generator/building-your-iexec-app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
### `iapp init`

**Purpose**: Initialize a new iApp project
**Usage**: `iapp init [options]`
**Usage**: `iapp init`
**What it does**: Creates project structure, configuration files, and basic
templates through interactive prompts.

Expand All @@ -150,7 +150,7 @@
**Options**:

- `--chain <string>` – Specify the blockchain network for deployment (e.g.,
`goerli`, `mainnet`)
`arbitrum-mainnet`, `bellecour`)

### `iapp run <iAppAddress>`

Expand All @@ -170,7 +170,7 @@
- `--requesterSecret <array>` – Key-value requester secrets (`index=value`)
available inside the iApp at `$IEXEC_REQUESTER_SECRET_*`
- `--chain <string>` – Specify the blockchain network to run the iApp on (e.g.,
`goerli`, `mainnet`)
`arbitrum-mainnet`, `bellecour`)

Check notice on line 173 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L173 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 173, "column": 2}}}, "severity": "INFO"}

### `iapp debug <taskId>`

Expand All @@ -183,36 +183,24 @@
**Options**:

- `--chain <string>` – Specify the blockchain network of the task (e.g.,
`goerli`, `mainnet`)
`arbitrum-mainnet`, `bellecour`)

Check notice on line 186 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L186 

[Google.Parens] Use parentheses judiciously.
Raw output 
{"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 186, "column": 13}}}, "severity": "INFO"}

### `iapp mock <inputType>`

**Purpose**: Create mocked input for testing purposes
**Purpose**: Create a mocked input for testing

Check warning on line 190 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L190 

[Google.Colons] ': C' should be in lowercase.
Raw output 
{"message": "[Google.Colons] ': C' should be in lowercase.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 190, "column": 12}}}, "severity": "WARNING"}
**Usage**: `iapp mock <inputType> [options]`
**Positional arguments**:

- `<inputType>` – Type of input to mock (e.g., `default`, `custom`)

**Options**:

- `--args <string>` – Arguments to use in the mock data
- `--protectedData <string>` – Protected data mock name to use
- `--inputFile <string>` – Input files to mock
- `--requesterSecret <array>` – Requester secrets to mock
- `<inputType>` – Type of input to mock [choices: "protectedData"]

Check failure on line 194 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L194 

[Google.EmDash] Don't put a space before or after a dash.
Raw output 
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 194, "column": 16}}}, "severity": "ERROR"}

### `iapp wallet <action>`

**Purpose**: Manage wallet-related operations
**Usage**: `iapp wallet <action> [options]`
**Positional arguments**:

- `<action>` – Wallet action to perform (e.g., `balance`, `address`, `sign`)

**Options**:

- `--chain <string>` – Specify the blockchain network (e.g., `goerli`,
`mainnet`)
- `--data <string>` – Data to sign (for `sign` action)
- `<action>` – Import a new wallet or select one from the keystore [choices:

Check failure on line 202 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L202 

[Google.EmDash] Don't put a space before or after a dash.
Raw output 
{"message": "[Google.EmDash] Don't put a space before or after a dash.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 202, "column": 13}}}, "severity": "ERROR"}
"import", "select"]

Check failure on line 203 in src/references/iapp-generator/building-your-iexec-app.md

View workflow job for this annotation

GitHub Actions / vale

[vale] src/references/iapp-generator/building-your-iexec-app.md#L203 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "src/references/iapp-generator/building-your-iexec-app.md", "range": {"start": {"line": 203, "column": 3}}}, "severity": "ERROR"}

## Advanced Options <ChainNotSupportedBadge />

Expand Down