config init

Interactive wizard. Five prompts, one written file: ./apyx.config.json.

apyx config init

• Synopsis
• What it asks
• What gets written
• Overwrite handling
• Exit codes
• Common follow-ups
• Related

Synopsis

apyx config init

No flags. The wizard runs in the current directory and writes ./apyx.config.json (the project config). Pre-existing files are detected and the wizard asks before overwriting.

What it asks

$ apyx config init
chain (ethereum | base) [ethereum]:
rpcUrl [https://eth.llamarpc.com]:
signer type (key | ledger | none) [key]:
keyPath [~/.apyx/keys/default]:
wrote /path/to/cwd/apyx.config.json
next: put your hex private key at ~/.apyx/keys/default
      (one line, 32 bytes; `chmod 600` the file).

After writing the file the wizard prints a “next:” reminder pointing at whichever path you chose for the key.

What gets written

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

Only one profile (default). To add more, edit the file by hand or add another profile block — the schema is in Configuration.

Overwrite handling

If ./apyx.config.json already exists:

$ apyx config init
./apyx.config.json already exists. Overwrite? (y/N): n
aborted

Decline and the file is untouched, exit code 1. The decline path is covered by an e2e spec — see test/e2e/cli/config.e2e.spec.ts.

Exit codes

Common follow-ups

After config init:

1. Drop your hex private key into the keyPath you chose:

   echo '0xYOUR_KEY' > ~/.apyx/keys/default
   chmod 600 ~/.apyx/keys/default
   

2. Verify the resolved config: apyx config show.
3. Open the REPL: apyx repl.

Related

• Configuration — the full config schema.
• config show — inspect what init wrote.
• config path — print the resolved config file path.