Skip to content

Document early access options. - #417

Open
bgravenorst wants to merge 2 commits into
Consensys-Incorporated:mainfrom
bgravenorst:DOC-416
Open

bgravenorst wants to merge 2 commits into
Consensys-Incorporated:mainfrom
bgravenorst:DOC-416

Conversation

@bgravenorst

@bgravenorst bgravenorst commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documents how to list early access CLI options, the options whose names start with --X and that --help omits.

  • Adds an Xhelp entry next to --help in the CLI options reference.
  • web3signer -X, web3signer --Xhelp, and web3signer Xhelp list the options grouped by command. web3signer eth2 -X and web3signer eth1 -X list only that subcommand's options.

The docs call these early access options, matching the Besu docs. The CLI output still labels them unstable.

Fixes #416.


Note

Low Risk
Documentation-only updates with no runtime or security behavior changes.

Overview
Documents how operators can discover early access CLI flags (--X…) that --help hides.

The CLI reference gains an Xhelp section for -X / --Xhelp, including a caution that these options may change without notice and examples for the root command, eth1, and eth2 (global list vs subcommand-scoped list). The distroless Docker how-to for read-only roots is updated in the same vein: wording now says “early access option,” and the tip points readers to web3signer eth2 -X via the new reference anchor instead of only noting the flag is hidden from help.

Reviewed by Cursor Bugbot for commit 5b174db. Bugbot is set up for automated code reviews on this repo. Configure here.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
@vercel

vercel Bot commented Oct 7, 2026

Copy link
Copy Markdown

@bgravenorst is attempting to deploy a commit to the Consensys Incorporated Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
doc-web3signer Ready Ready Preview Oct 7, 2026 2:01am UTC

Request Review

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

This branch was successfully deployed

1 active deployment
Preview — 5b174db6 Deployed Oct 7, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document -X / --Xhelp for listing unstable CLI options

1 participant