Document Access node CLI flags
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
Issue to be solved
Document the CLI flags relevant for Access nodes, and include explanations of the different systems they configure, side effects and best practices.
The complete list of Access specific flags are here:
https://github.com/onflow/flow-go/blob/5ba2b2748427eb2b25535872fae41e61e2dfbe95/cmd/access/node_builder/access_node_builder.go#L973
The complete list of share flags are here:
https://github.com/onflow/flow-go/blob/master/cmd/scaffold.go#L147
Ideally, we would have this for all nodes, but ANs are the most likely to have new operators coming online and have the largest number of options.
Suggest A Solution
No response
What are you currently working on that this is blocking?
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Access-specific flags in cmd/access/node_builder/access_node_builder.go around line 973 and the shared flags in cmd/scaffold.go around line 147. Document every relevant flag, including the systems it configures, side effects, and best practices; completion means the Access node operator guidance covers both flag lists.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- blockchain, cli
- Domain
- blockchain, cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100