Skip to content

docs: document replay command in CLI reference #2919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bkryu merged 1 commit into from
Apr 6, 2026
Merged

docs: document replay command in CLI reference #2919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,20 @@ Clear JIT compilation cache:
.. code-block:: bash

flashinfer clear-cache

Replay Recorded Calls
---------------------

Replay API dumps captured by the Level 10 "Flight Recorder" logging mode:
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The replay command not only executes the recorded calls but also verifies the results against the original outputs. Explicitly mentioning this verification capability would better reflect the command's primary purpose of ensuring correctness.

Suggested change
Replay API dumps captured by the Level 10 "Flight Recorder" logging mode:
Replay and verify API dumps captured by the Level 10 "Flight Recorder" logging mode:


.. code-block:: bash

# Replay all recorded calls in a dump session
flashinfer replay --dir ./flashinfer_dumps

# Replay a single recorded call
flashinfer replay --dir ./flashinfer_dumps/<dump_directory>
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the bash example, ./flashinfer_dumps/<dump_directory> uses angle brackets, which in many shells are treated as I/O redirection tokens if copy/pasted. Consider using a safer placeholder (e.g., ./flashinfer_dumps/DUMP_DIRECTORY_NAME) or quoting the path to avoid users running a broken command.

Suggested change
flashinfer replay --dir ./flashinfer_dumps/<dump_directory>
flashinfer replay --dir ./flashinfer_dumps/DUMP_DIRECTORY_NAME

Copilot uses AI. Check for mistakes.

The ``replay`` command accepts either the root dump directory or a single dump
subdirectory. For the full dump/replay workflow and Level 10 logging
configuration, see :ref:`logging`.
Loading