Skip to main content

Documentation Index

Fetch the complete documentation index at: https://grat.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Grat CLI is a Phase 4 feature and is currently in the design phase. The commands listed below represent the planned command structure and functionality.
The Grat CLI provides a powerful way to manage your relay, configure policies, fund channels, and monitor transactions directly from your terminal.

​
Usage

grat [command] [options]

​
Planned Commands

  • grat init: Initialize a new Grat project and generate a .env file.
  • grat login: Authenticate with your managed cloud account.
  • grat status: Check the health and version of your relay.
  • grat keys list: List all API keys for the current project.
  • grat keys create: Generate a new API key (test or live).
  • grat keys revoke [key]: Deactivate an existing API key.
  • grat channels list: Show the status and balance of all fee channels.
  • grat channels fund [amount]: Send XLM to top up channel balances.
  • grat channels rotate: Manually trigger a rotation of the channel seed.
  • grat policies list: List all active sponsorship policies.
  • grat policies create: Add a new policy via an interactive prompt.
  • grat policies delete [id]: Remove a policy.
  • grat balance: Show the remaining XLM credit balance.
  • grat deposit: Get the deposit address for project top-ups.
  • grat usage: Show historical credit spending by asset and contract.
  • grat logs: Stream real-time logs from your relay instance.
  • grat tx get [hash]: Inspect the sponsorship details of a specific hash.
  • grat events: Listen for Soroban diagnostic events emitted by the relay.
View on GitHub