@fairdatasociety/fdp-cli/src/config.ts

CLI tool for FDP-Storage

import { IOption } from 'furious-commander'
import { getPackageVersion } from './utils'
import { Account } from './command/account'
import { Directory } from './command/directory'
import { Pod } from './command/pod'
import { File } from './command/file'

/**
 * ENS network name
 *
 * Using the value will be received RPC url and smart contract addresses for initializing `FdpStorage`
 */
export const ensNetwork: IOption<string> = {
  key: 'ens-network',
  default: 'goerli',
  description:
    'Name of the configuration with blockchain RPC and smart contract addresses. Allowed values: `goerli` and `fdp-play`',
  envKey: 'ENS_NETWORK',
}

/**
 * Domain name of the ENS
 *
 * It is not necessary to define for built-in networks, but it can be helpful for custom networks.
 * Use during initializing `FdpStorage`
 */
export const ensDomain: IOption<string> = {
  key: 'ens-domain',
  description: 'Domain name of the ENS',
  envKey: 'ENS_DOMAIN',
}

/**
 * RPC url for interacting with ENS
 */
export const ensRpcUrl: IOption<string> = {
  key: 'ens-rpc-url',
  description: 'RPC url for interacting with ENS',
  envKey: 'ENS_RPC_URL',
}

export const beeApiUrl: IOption<string> = {
  key: 'bee-api-url',
  default: 'http://localhost:1633',
  description: 'URL of the Bee-client API',
  envKey: 'BEE_API_URL',
}

export const beeDebugApiUrl: IOption<string> = {
  key: 'bee-debug-api-url',
  default: 'http://localhost:1635',
  description: 'URL of the Bee-client Debug API',
  envKey: 'BEE_DEBUG_API_URL',
}

export const configFolder: IOption<string> = {
  key: 'config-folder',
  description: 'Path to the configuration folder that the CLI uses',
  envKey: 'FDP_CLI_CONFIG_FOLDER',
}

export const configFile: IOption<string> = {
  key: 'config-file',
  description: 'Name of the configuration file that the CLI uses',
  envKey: 'FDP_CLI_CONFIG_FILE',
  default: 'config.json',
}

export const help: IOption<boolean> = {
  key: 'help',
  alias: 'h',
  description: 'Print context specific help and exit',
  type: 'boolean',
  default: false,
}

export const version: IOption<boolean> = {
  key: 'version',
  alias: 'V',
  description: 'Print version and exit',
  type: 'boolean',
  default: false,
  handler: () => {
    process.stdout.write(getPackageVersion() + '\n')
  },
}

export const verbose: IOption<boolean> = {
  key: 'verbose',
  alias: 'v',
  description: 'Print all console messages',
  type: 'boolean',
  default: false,
}

export const quiet: IOption<boolean> = {
  key: 'quiet',
  alias: 'q',
  description: 'Only print the results',
  type: 'boolean',
  default: false,
}

export const yes: IOption<string[]> = {
  type: 'boolean',
  key: 'yes',
  alias: 'y',
  description: 'Agree to all prompts',
}

export const rootCommandClasses = [Account, Pod, Directory, File]

export const optionParameters: IOption[] = [
  ensNetwork,
  ensDomain,
  ensRpcUrl,
  beeApiUrl,
  beeDebugApiUrl,
  configFolder,
  configFile,
  help,
  version,
  verbose,
  quiet,
  yes,
]