Metaplay Docs

Appearance

metaplay llm-docs ripgrep PATTERN [flags]

[preview] Run a ripgrep search against the llm-docs payload (machine use only)

metaplay llm-docs ripgrep PATTERN [flags] ​

PREVIEW: This command is in preview and subject to change!

Run a ripgrep search against the llm-docs payload and print the raw text response. Intended for machine consumption (e.g. AI coding agents); the output format is not stable for human-driven workflows.

Examples ​

sh
# Default regex search across the whole payload.
metaplay llm-docs ripgrep "Player(Actor|State)"
# Case-insensitive literal-string search, restricted to markdown docs.
metaplay llm-docs ripgrep "in-app purchase" --fixed -i --type md
# Show two lines of surrounding context for each match.
metaplay llm-docs ripgrep EntityKind -C 2
# List only the files that contain the pattern.
metaplay llm-docs ripgrep PlayerActorBase -l
# Count matches per file in C# sources.
metaplay llm-docs ripgrep "throw new" -c --type cs
# Restrict search to a glob filter (matched against file names).
metaplay llm-docs ripgrep "EntityActor" --glob "*.cs" --path MetaplaySDK/Backend
# that span lines).
metaplay llm-docs ripgrep "class\s+\w+\s*:\s*EntityActor" --multiline -n
# Scope a search to a subdirectory of the payload.
metaplay llm-docs ripgrep EntityKind --path MetaplaySDK

Flags ​

  • --after-context <int>: Lines of context after each match (default: 0)
  • --before-context <int>: Lines of context before each match (default: 0)
  • --context <int>: Lines of context before and after each match (default: 0)
  • --count: Show only the count of matches per file
  • --files-with-matches: List only the files that contain matches
  • --fixed: Treat PATTERN as a literal string instead of a regex
  • --glob <stringSlice>: Restrict search to glob patterns (repeatable, e.g. --glob '*.md') (default: [])
  • --ignore-case: Case-insensitive matching
  • --line-numbers: Show line numbers in matches
  • --multiline: Allow matches to span multiple lines
  • --path <string>: Subdirectory of the docs payload to search in
  • --type <stringSlice>: Restrict search to file types (repeatable, e.g. --type md --type go) (default: [])

Inherited Flags ​

  • --color <string>: Should the output be colored (yes/no/auto)? [env: METAPLAYCLI_COLOR] (default: auto)
  • --project <string>: Path to the to project directory (where metaplay-project.yaml is located)
  • --skip-version-check: Skip the check for a new CLI version being available
  • --verbose: Enable verbose logging, useful for troubleshooting [env: METAPLAYCLI_VERBOSE]