Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
---
|
|
description: Using and Developing Ignite Apps
|
|
---
|
|
|
|
# Using Ignite Apps
|
|
|
|
Apps offer a way to extend the functionality of the Ignite CLI. There are two
|
|
core concepts within apps: `Commands` and `Hooks`. `Commands` extend the CLI's
|
|
functionality and `Hooks` extend existing CLI command functionality.
|
|
|
|
Apps are registered in an Ignite scaffolded blockchain project through the
|
|
`igniteapps.yml`, or globally through `$HOME/.ignite/apps/igniteapps.yml`.
|
|
|
|
To use an app within your project execute the following command inside the
|
|
project directory:
|
|
|
|
```sh
|
|
ignite app install github.com/project/cli-app
|
|
```
|
|
|
|
The app will be available only when running `ignite` inside the project
|
|
directory.
|
|
|
|
To use an app globally on the other hand, execute the following command:
|
|
|
|
```sh
|
|
ignite app install -g github.com/project/cli-app
|
|
```
|
|
|
|
The command will compile the app and make it immediately available to the
|
|
`ignite` command lists.
|
|
|
|
## Listing installed apps
|
|
|
|
When in an ignite scaffolded blockchain you can use the command `ignite app
|
|
list` to list all Ignite Apps and there statuses.
|
|
|
|
## Updating apps
|
|
|
|
When an app in a remote repository releases updates, running `ignite app
|
|
update <path/to/app>` will update an specific app declared in your
|
|
project's `config.yml`.
|