Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

config show

Print the merged config (project ⨁ home) as pretty JSON. Use it to verify what the CLI actually sees after both files have been read and the project’s profiles have replaced any same-named home profiles.

apyx config show

Synopsis

apyx config show [--profile <name>]
FlagDefaultEffect
--profile <name>(none — print everything)Print only the named profile, exit 1 with Unknown profile if it doesn’t exist.

Examples

Whole config

$ apyx config show
{
  "defaultProfile": "default",
  "profiles": {
    "default": {
      "chain": "ethereum",
      "rpcUrl": "https://eth.llamarpc.com",
      "signer": { "type": "key", "keyPath": "~/.apyx/keys/default" }
    },
    "base": {
      "chain": "base",
      "rpcUrl": "https://mainnet.base.org",
      "signer": { "type": "key", "keyPath": "~/.apyx/keys/default" }
    }
  }
}

Single profile

$ apyx config show --profile base
{
  "chain": "base",
  "rpcUrl": "https://mainnet.base.org",
  "signer": { "type": "key", "keyPath": "~/.apyx/keys/default" }
}

No config found

$ cd /tmp && apyx config show
No config found. Run `apyx config init`.
echo $?    # 1

Unknown profile

$ apyx config show --profile staging
Unknown profile "staging". Known: default, base
echo $?    # 1

What “merged” means

The output is the result of merging ~/.apyx/config.json (or $XDG_CONFIG_HOME/apyx/config.json) and ./apyx.config.json per the rules in Configuration → Resolution rules. The merge happens in memory; no file is written. To see which file each profile came from, use apyx config path.

Exit codes

CodeMeaning
0Printed the (filtered) config
1No config found / unknown profile
2Usage error (unknown flag)