Skip to content

Commit

Permalink
Merge pull request #193 from Apillon/indexer-cli-docs
Browse files Browse the repository at this point in the history
Add indexer CLI docs
  • Loading branch information
dimitrov-d authored Oct 29, 2024
2 parents 3e92fe7 + 98cdbc2 commit ea40ff7
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions build/6-apillon-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,25 @@ apillon nfts list-transactions --uuid "123e4567-e89b-12d3-a456-426655440000"
}
```

## Indexing Commands

#### `indexing deploy`

Deploy a local squid indexer repository to an Apillon indexer with a specific UUID.
The CLI zips files that were added to tar.gz archive, which is created in the builds/ directory.
The compressed file is uploaded to S3, and the deployment is started. The deployment can take some time, and progress can be monitored on the [Apillon developer console](https://app.apillon.io/dashboard/service/indexing).

**Options**

- `<path>`: Path to local squid repository (indexer source code).
- `-i <indexer-uuid>`: UUID of the indexer to be deployed.

**Example**

```sh
apillon indexing deploy ./local-path -i "7af5bea4-7989-41fe-958a-dfe7fa8ff72d"
```

## Using in CI/CD tools

CLI is particularly useful for CI/CD builds and pipelines.
Expand Down

0 comments on commit ea40ff7

Please sign in to comment.