OS Manuals

/usr/bin/clef

From op-geth-clef 1.101702.2-r2 (os), captured 2026-11-05 by running clef --help (exit 0). permalink

Also provided by 1 other package version
NAME:
   Clef - Manage Ethereum account operations

USAGE:
   Clef [global options] command [command options]

VERSION:
   1.101702.2-stable-e8800cff

COMMANDS:
   init           Initialize the signer, generate secret storage
   attest         Attest that a js-file is to be used
   setpw          Store a credential for a keystore file
   delpw          Remove a credential for a keystore file
   newaccount     Create a new account
   importraw      Import a hex-encoded private key.
   gendoc         Generate documentation about json-rpc format
   list-accounts  List accounts in the keystore
   list-wallets   List wallets known to Clef
   help, h        Shows a list of commands or help for one command

GLOBAL OPTIONS:

    --4bytedb-custom value              (default: "./4byte-custom.json")
          File used for writing new 4byte-identifiers submitted via API

    --advanced                          (default: false)
          If enabled, issues warnings instead of rejections for suspicious requests.
          Default off

    --auditlog value                    (default: "audit.log")
          File used to emit audit logs. Set to "" to disable

    --chainid value                     (default: 1)
          Chain id to use for signing (1=mainnet, 17000=Holesky)

    --configdir value                   (default: "/tmp/.clef")
          Directory for Clef configuration

    --keystore value                    (default: "/tmp/.ethereum/keystore")
          Directory for the keystore

    --loglevel value                    (default: 3)
          log level to emit to the screen

    --rules value
          Path to the rule file to auto-authorize requests with

    --signersecret value
          A file containing the (encrypted) master seed to encrypt Clef data, e.g.
          keystore credentials and ruleset hash

    --stdio-ui                          (default: false)
          Use STDIN/STDOUT as a channel for an external UI. This means that an
          STDIN/STDOUT is used for RPC-communication with a e.g. a graphical user
          interface, and can be used when Clef is started by an external process.

    --stdio-ui-test                     (default: false)
          Mechanism to test interface between Clef and UI. Requires 'stdio-ui'.

    --suppress-bootwarn                 (default: false)
          If set, does not show the warning during boot

   ACCOUNT


    --lightkdf                          (default: false)
          Reduce key-derivation RAM & CPU usage at some expense of KDF strength

    --pcscdpath value                   (default: "/run/pcscd/pcscd.comm")
          Path to the smartcard daemon (pcscd) socket file

   API AND CONSOLE


    --http                              (default: false)
          Enable the HTTP-RPC server

    --http.addr value                   (default: "localhost")
          HTTP-RPC server listening interface

    --http.port value                   (default: 8550)
          HTTP-RPC server listening port

    --http.vhosts value                 (default: "localhost")
          Comma separated list of virtual hostnames from which to accept requests (server
          enforced). Accepts '*' wildcard.

    --ipcdisable                        (default: false)
          Disable the IPC-RPC server

    --ipcpath value
          Filename for IPC socket/pipe within the datadir (explicit paths escape it)

   MISC


    --help, -h                          (default: false)
          show help

    --version, -v                       (default: false)
          print the version


COPYRIGHT:
   Copyright 2013-2026 The go-ethereum Authors
Options (22)
OptionDescriptionSource
--4bytedb-custom value(default: "./4byte-custom.json") File used for writing new 4byte-identifiers submitted via APIhelp
--advanced(default: false) If enabled, issues warnings instead of rejections for suspicious requests.help
--auditlog value(default: "audit.log") File used to emit audit logs.help
--chainid value(default: 1) Chain id to use for signing (1=mainnet, 17000=Holesky)help
--configdir value(default: "/tmp/.clef") Directory for Clef configurationhelp
--keystore value(default: "/tmp/.ethereum/keystore") Directory for the keystorehelp
--loglevel value(default: 3) log level to emit to the screenhelp
--rules valuePath to the rule file to auto-authorize requests withhelp
--signersecret valueA file containing the (encrypted) master seed to encrypt Clef data, e.g. keystore credentials and ruleset hashhelp
--stdio-ui(default: false) Use STDIN/STDOUT as a channel for an external UI.help
--stdio-ui-test(default: false) Mechanism to test interface between Clef and UI.help
--suppress-bootwarn(default: false) If set, does not show the warning during boothelp
--lightkdf(default: false) Reduce key-derivation RAM & CPU usage at some expense of KDF strengthhelp
--pcscdpath value(default: "/run/pcscd/pcscd.comm") Path to the smartcard daemon (pcscd) socket filehelp
--http(default: false) Enable the HTTP-RPC serverhelp
--http.addr value(default: "localhost") HTTP-RPC server listening interfacehelp
--http.port value(default: 8550) HTTP-RPC server listening porthelp
--http.vhosts value(default: "localhost") Comma separated list of virtual hostnames from which to accept requests (server enforced).help
--ipcdisable(default: false) Disable the IPC-RPC serverhelp
--ipcpath valueFilename for IPC socket/pipe within the datadir (explicit paths escape it)help
--help, -h(default: false) show helphelp
--version, -v(default: false) print the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.