From 98cdbc2ee1a11b51833b915439cd04c99d6b56cc Mon Sep 17 00:00:00 2001 From: Damjan Dimitrov Date: Tue, 29 Oct 2024 10:38:14 +0100 Subject: [PATCH] Add indexer CLI docs --- build/6-apillon-cli.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/build/6-apillon-cli.md b/build/6-apillon-cli.md index d335c6a8..a5e55a50 100644 --- a/build/6-apillon-cli.md +++ b/build/6-apillon-cli.md @@ -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 to local squid repository (indexer source code). +- `-i `: 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.