Skip to content
Merged
Changes from all commits
Commits
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: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

<p align="center">
<img src="demo.gif" alt="animated" width="80%" />
Expand All @@ -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)

Expand Down