Configure

The configuration command is required to be run before any other commands. When you run this command, we check if there exist a configuration file. If no configuration file is found, we create it. If a configuration exists, then we ask if you want to override the configuration.

1. config
2. config:view
3. config:user
4. config:networks

Config

Usage

holograph config

Help Output

USAGE
  $ holograph config [--url <value> --network
    seiTestnetArctic|lineaTestnetSepolia|mantleTestnetSepolia|lineaTestnetGoerli|zoraTestnetSepolia|baseTestnetSepolia|a
    rbitrumTestnetSepolia|optimismTestnetSepolia|ethereumTestnetSepolia|mantleTestnet|polygonTestnet|avalancheTestnet|bi
    nanceSmartChainTestnet] [--privateKey <value>] [--fromFile <value>] [--fromJson <value>]

FLAGS
  --fromFile=<value>    Path to the config file to load
  --fromJson=<value>    JSON object to use as the config
  --network=<option>    Network to set
                        <options: seiTestnetArctic|lineaTestnetSepolia|mantleTestnetSepolia|lineaTestnetGoerli|zoraTestn
                        etSepolia|baseTestnetSepolia|arbitrumTestnetSepolia|optimismTestnetSepolia|ethereumTestnetSepoli
                        a|mantleTestnet|polygonTestnet|avalancheTestnet|binanceSmartChainTestnet>
  --privateKey=<value>  Default account to use when sending all transactions
  --url=<value>         Provider URL of network to set

DESCRIPTION
  Initialize the Holograph CLI with a config file. If no flags are passed, the CLI will prompt you for the required
  information.

EXAMPLES
  $ holograph config --privateKey abc...def

  $ holograph config --fromFile ./config.json

  $ holograph config --fromJson '{"version": "beta3", ...}

See code: src/commands/config/index.ts

Flags

--fromFile

If you are an advanced user, you can pass the directory of the config file you want to use. It is parsed and will throw an error if the file is not valid.

--fromJson

If you are an advanced user, you can pass the config json object directly. It is parsed and will throw an error if the file is not valid.

--network

The network you want to set in the configuration file. The only acceptable values are:

1. seiTestnetArctic
2. lineaTestnetSepolia
3. mantleTestnetSepolia
4. lineaTestnetGoerli
5. zoraTestnetSepolia
6. baseTestnetSepolia
7. arbitrumTestnetSepolia
8. optimismTestnetSepolia
9. ethereumTestnetSepolia
10. mantleTestnet
11. polygonTestnet
12. avalancheTestnet
13. binanceSmartChainTestnet

--privateKey

You can pass in the private key as a flag to the command. This should be for advanced users.

--url

Depends on the network flag set and must be a valid secure websocket url.

Config View

See the entire configuration file. You can also choose the output format JSON or Yaml.

Usage

holograph config:view

Help Output

USAGE
  $ holograph config:view [--output clean|json|yaml] [--env mainnet|testnet|develop|experimental]

FLAGS
  --env=<option>     [default: testnet] Holograph environment to use
                     <options: mainnet|testnet|develop|experimental>
  --output=<option>  Output format
                     <options: clean|json|yaml>

DESCRIPTION
  View the current config state of the Holograph CLI.

EXAMPLES
  $ holograph config:view --env mainnet|testnet|develop|experimental

  $ holograph config:view --output json --env mainnet|testnet|develop|experimental

  $ holograph config:view --output yaml --env mainnet|testnet|develop|experimental

  $ holograph config:view --output clean --env mainnet|testnet|develop|experimental

See code: src/commands/config/view.ts

Flags

--env

Select the holograph environment to use. Only ['mainnet', 'testnet', 'develop', 'experimental'] are accepted

--output

Choose how the format of the stdout. Only ['json', 'yaml', 'clean'] are accepted

Config User

View the address of the user in the configuration file

Usage

holograph config:user

Help Output

USAGE
  $ holograph config:user [--output clean|json|yaml] [--env mainnet|testnet|develop|experimental]

FLAGS
  --env=<option>     [default: testnet] Holograph environment to use
                     <options: mainnet|testnet|develop|experimental>
  --output=<option>  Output format
                     <options: clean|json|yaml>

DESCRIPTION
  View the current user information.

EXAMPLES
  $ holograph config:user --env mainnet|testnet|develop|experimental

  $ holograph config:user --output json --env mainnet|testnet|develop|experimental

  $ holograph config:user --output yaml --env mainnet|testnet|develop|experimental

  $ holograph config:user --output clean --env mainnet|testnet|develop|experimental

See code: src/commands/config/user.ts

Flags

--env

Select the holograph environment to use. Only ['mainnet', 'testnet', 'develop', 'experimental'] are accepted

--output

Choose how the format of the stdout. only ['json', 'yaml', 'clean'] are accepted

Config Networks

View the networks and websockets defined in the configuration file.

Usage

holograph config:networks

Help Output

USAGE
  $ holograph config:networks [--output clean|json|yaml] [--env mainnet|testnet|develop|experimental]

FLAGS
  --env=<option>     [default: testnet] Holograph environment to use
                     <options: mainnet|testnet|develop|experimental>
  --output=<option>  Output format
                     <options: clean|json|yaml>

DESCRIPTION
  View the current network config.

EXAMPLES
  $ holograph config:networks --env mainnet|testnet|develop|experimental

  $ holograph config:networks --output json --env mainnet|testnet|develop|experimental

  $ holograph config:networks --output yaml --env mainnet|testnet|develop|experimental

  $ holograph config:networks --output clean --env mainnet|testnet|develop|experimental

See code: src/commands/config/networks.ts

Flags

--env

Select the holograph environment to use. Only ['mainnet', 'testnet', 'develop', 'experimental'] are accepted

--output

Choose how the format of the stdout. only ['json', 'yaml', 'clean'] are accepted