@starship-ci/cli/utils.d.ts

Starship CLI

import { StarshipConfig, StarshipContext } from '@starship-ci/client';
export declare function displayVersion(): void;
export interface Config {
    context: StarshipContext;
    starship: StarshipConfig;
}
export declare const params: string[];
export declare const loadConfig: (argv: any) => Config;
export declare const usageText = "\nUsage: starship <command> [options]\n\nCommands:\n  start              Start the Starship services.\n  stop               Remove all components related to the deployment.\n  deploy             Deploy starship using specified options or configuration file.\n  setup              Setup initial configuration and dependencies.\n  start-ports        Start port forwarding for the deployed services.\n  stop-ports         Stop port forwarding.\n  delete             Delete a specific Helm release.\n  get-pods           Get the list of pods for the Helm release.\n  clean              Perform a clean operation to tidy up resources.\n  verify             Verify the status of deployed services and endpoints.\n                     Checks:\n                     - Chain REST endpoints (supply)\n                     - Chain RPC endpoints (block height)\n                     - Chain Faucet endpoints (chain ID)\n                     - Chain Exposer endpoints (node ID)\n                     - Ethereum REST endpoints (sync status)\n                     - Ethereum RPC endpoints (sync status)\n                     - Registry service (chain list)\n                     - Explorer service (dashboard)\n                     - Relayer service (version)\n  version, -v        Display the version of the Starship Client.\n\nConfiguration File:\n  --config <path>       Specify the path to the configuration file containing the actual config file. Required.\n                        Command-line options will override settings from this file if both are provided.\n\nCommand-line Options:\n  --name <name>     Specify the Helm release name, default: starship.\n                        Will overide config file settings for name.\n  --version <ver>   Specify the version of the Helm chart, default: v0.2.6.\n                        Will overide config file settings for version.\n  --timeout <time>  Specify the timeout for the Helm operations, default: 10m.\n                        Will overide config file settings for timeout.\n\nExamples:\n  $ starship start --config ./config/two-chain.yaml\n  $ starship stop --config ./config/two-chain.yaml\n  $ starship verify --config ./config/two-chain.yaml\n  $ starship verify --config ./config/two-chain.yaml --name my-starship\n\nIf you want to setup starship for the first time\n  $ starship setup\n\nIf you want to run the deployment step by step\n  $ starship deploy --config ./config/two-chain.yaml\n  $ starship start-ports --config ./config/two-chain.yaml\n  $ starship stop-ports --config ./config/two-chain.yaml\n  $ starship delete --config ./config/two-chain.yaml\n\nAdditional Help:\n  $ starship help          Display this help information.\n";
export declare function displayUsage(): void;