diff --git a/README.md b/README.md index f1d1d8f..0ea0847 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Replay: save and replay sequences of shell commands -Replay is a lightweight CLI tool to record, replay, and manage shell command sessions. Ideal for automation, reproducibility, and quick demonstrations. +Replay is a lightweight CLI tool to record, stash-like save, and replay shell command sessions. +It’s ideal for automation, reproducibility, and quick demonstrations.

animated @@ -19,15 +20,23 @@ cargo install replay_pty ```sh replay record ``` -Use `replay record -h` to see all the options available for this command +Use `replay record -h` to see all the options available for this command. +Recording a session automatically saves it in a **stash-like index**, similar to how git stash works. +For example, the most recent session is accessible as: +```sh + replay run replay@{0} +``` ### Replay a Session To run a recorded session of commands : ```sh -replay run # runs the last recorded session by default +replay run # runs the last recorded session (replay@{0}) +``` +You can also run a specific saved session by index: +```sh +replay run replay@{2} ``` Use `replay run -h` to see all the options available for this command - ## License Replay is licenced under MIT license ([LICENSE-MIT](./LICENSE-MIT) or http://opensource.org/licenses/MIT)