diff --git a/README.md b/README.md index d9aa694..f1d1d8f 100644 --- a/README.md +++ b/README.md @@ -2,54 +2,43 @@ Replay is a lightweight CLI tool to record, replay, and manage shell command sessions. Ideal for automation, reproducibility, and quick demonstrations. +

+ animated +

+ ## Installation ```sh -cargo install replay -``` -## Usage -```sh -replay [OPTIONS] +cargo install replay_pty ``` -### Available Commands +## Usage +💡 Run `replay help` to see all available commands. +### Record a Session ```sh -replay run [OPTIONS] [SESSION_NAME] +replay record ``` +Use `replay record -h` to see all the options available for this command -Run a replay on the specified session. - -#### Arguments -- `SESSION_NAME`: The name of the session to replay. If omitted, the last session will be used. - -#### Options -- `-s`, `--show`: Show the commands without executing them. -- `-d`, `--delay `: Delay (in milliseconds) between commands. Default to `0`. -- `-h`, `--help`: Show help for this commands. - ---- - +### Replay a Session +To run a recorded session of commands : ```sh -replay record [SESSION_NAME] +replay run # runs the last recorded session by default ``` -Record a new session of shell commands. If a session name is provided, it will be used to label the recording. +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) -```sh -replay help -``` -Show help for the CLI or a specific subcommand. -### Global Options -- `-h`, `--help`: show general help. -- `-V`, `--version`: show version information. +## Contributing -## Git Hook +Contributions are very welcome! +Please see our [contributing guide](./CONTRIBUTING.md) for details. -To enable a pre-configured Git hook that automatically formats your code before each commit: -```sh -git config core.hooksPath .githooks -``` -> Run these commands once after cloning the repository to ensure the hooks are active. +Thanks to all the people who already contributed! + + + All contributors + diff --git a/demo.gif b/demo.gif new file mode 100644 index 0000000..81da4cf Binary files /dev/null and b/demo.gif differ