Skip to main content
Commands

vg guide

Cited, relevant standards and practices for a node in your code map — a free pack of guidance attached to the symbol you name.

Overview

vg guide <name> returns cited, relevant standards and practices for a node in your code map — a free guidance pack attached to the symbol you name. It answers "what should I keep in mind when I touch this?" with references, not opinions.


Usage

vg guide <name>

When the name is ambiguous — several nodes share it — pick the candidate you mean:

vg guide handler --pick 2

Options

FlagDescription
--pick <n>Pick the nth candidate when the name is ambiguous
--jsonMachine-readable JSON on stdout

Related

  • vg facts — deterministic facts for a node
  • vg show — inspect a node in the code map

Example use cases

Expand any use case to watch a live replay of the real @vibgrate/cli running against one of our test repositories. Nothing executes in your browser — these are recordings of actual runs, with the scan time shown as of now.

vg guide createUser

Related Documentation