Skip to content
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.

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

refactor: rename apps to extensions #4238

Closed
wants to merge 12 commits into from
1 change: 1 addition & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
- [#4194](https://github.com/ignite/cli/pull/4194) Bump client/v2 to `v2.0.0-beta.2`
- [#4189](https://github.com/ignite/cli/pull/4189) Deprecate `ignite node` for `ignite connect` app
- [#4210](https://github.com/ignite/cli/pull/4210) Improve default home wiring
- [#4238](https://github.com/ignite/cli/pull/4238) Rename Ignite Apps to Ignite Extensions

### Fixes

Expand Down
42 changes: 0 additions & 42 deletions docs/docs/apps/01-using-apps.md

This file was deleted.

258 changes: 0 additions & 258 deletions docs/docs/apps/02-developing-apps.md

This file was deleted.

42 changes: 42 additions & 0 deletions docs/docs/extensions/01-using-extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
description: Using and Developing Ignite Extensions
---

# Using Ignite Extensions

Extensions offer a way to extend the functionality of the Ignite CLI. There are two
core concepts within extensions: `Commands` and `Hooks`. `Commands` extend the CLI's
functionality and `Hooks` extend existing CLI command functionality.

Extensions are registered in an Ignite scaffolded blockchain project through the
`extensions.yml`, or globally through `$HOME/.ignite/extensions/extensions.yml`.

To use an extension within your project execute the following command inside the
project directory:

```sh
ignite ext install github.com/project/cli-extension
```

The extension will be available only when running `ignite` inside the project
directory.

To use an extension globally on the other hand, execute the following command:

```sh
ignite ext install -g github.com/project/cli-extension
```

The command will compile the extension and make it immediately available to the
`ignite` command lists.

## Listing installed Extensions

When in an ignite scaffolded blockchain you can use the command `ignite extension
list` to list all Ignite Extensions and there statuses.

## Updating Extensions

When an extension in a remote repository releases updates, running `ignite extension
update <path/to/extension>` will update an specific extension declared in your
project's `config.yml`.
Loading
Loading