Metaplay Docs

Appearance

metaplay llm-docs read PATH [flags]

[preview] Read a single file from the llm-docs payload (machine use only)

metaplay llm-docs read PATH [flags] ​

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

Read a single file from the llm-docs payload and print its raw contents. Intended for machine consumption (e.g. AI coding agents); the output format is not stable for human-driven workflows.

Examples ​

sh
# Show the root catalog.
metaplay llm-docs read index.md
# Read a docs page (.md is auto-appended server-side when no extension is given).
metaplay llm-docs read docs/cloud-deployments/getting-started
# Read a file from a sample project.
metaplay llm-docs read samples/HelloWorld/Assets/SharedCode/Player/PlayerModel.cs
# Read the SDK version metadata.
metaplay llm-docs read MetaplaySDK/version.yaml
# Read a 100-line slice starting at line 500 (paged read).
metaplay llm-docs read samples/HelloWorld/Assets/SharedCode/Player/PlayerModel.cs --offset 500 --limit 100

Flags ​

  • --limit <int>: Maximum number of lines to return (defaults to the server-side default) (default: 0)
  • --offset <int>: 1-indexed line to start reading from (defaults to line 1) (default: 0)

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]