Skip to content

Commit

Permalink
readme: add quick start guide
Browse files Browse the repository at this point in the history
  • Loading branch information
joshi4 committed Jan 12, 2024
1 parent a58f2ab commit f732e5c
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,53 @@
# Savvy

Savvy helps your create and share runbooks directly from your terminal.

## Demo

![Savvy Runbook](https://vhs.charm.sh/vhs-1UmW0o6uSztF6b76y92K2K.gif)

## Quick Start

Follow these steps to get started:

1. **Install Savvy CLI**

Run the following command in your terminal

```sh
curl -fsSL https://install.getsavvy.so | sh
```

Follow the on-screen instructions to complete the installation.

2. **Login**

Before you can create runbooks using the CLI you need to login. Use the following command:

```sh
savvy login
```

3. **Create a Runbook**

Run the following command to start creating a runbook from your terminal:

```sh
savvy record
```

Perform the tasks you wish to record in your terminal. When you're done, you can stop the recording by typing `exit` or pressing `ctrl-D`.

## Limitations

Currently, Savvy does not support the following:

* Windows OS
* Any shell other than `zsh`.

## Getting Help

If you need assistance or have questions:

* **Create an Issue**: [Create an issue](https://github.com/getsavvyinc/savvy-cli/issues/new) on our GitHub repository.
* **Join Our Discord**: Connect with the community on [Discord](https://getsavvy.so/discord)

0 comments on commit f732e5c

Please sign in to comment.