Skip to content

Commit

Permalink
README: reorder README and add savvy sync
Browse files Browse the repository at this point in the history
  • Loading branch information
joshi4 committed Dec 16, 2024
1 parent b892e5a commit 6b8cd27
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 37 deletions.
78 changes: 41 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,87 +7,91 @@
<a href="https://docs.getsavvy.so">Docs</a> |
</h3>

Savvy is the easiest way to create, share and run runbooks from your terminal.
Savvy is the easiest way to create, share and run workflows from your terminal.


Savvy's CLI generates runbooks with AI or from commands you provide.
Savvy's CLI generates workflows with AI or from commands you provide.

## Install Savvy's CLI

```sh
curl -fsSL https://install.getsavvy.so | sh
```
## Generate Workflows using your commands

## Generate Runbooks with AI
Use `savvy record` or `savvy record history` to create a workflow using commands you provide.

Use `savvy ask` to generate entire runbooks or a single command using natural language.
You don't have to change anything about your shell or aliases, savvy auto expands all aliases to make sure your workflow runs reliably on any machine.

Just run `savvy ask` and provide a prompt.
### Create Workflows from your Shell History

Any one can use it, there's no need to signup for an account or provide a credit card.
Use `savvy record history` to go back in time and create a workflows by selecting just the commands you want.

### Examples
Savvy will never execute any command you select.

1. Ask Savvy to create a runbook for publishing a new go module.

![Ask Savvy to create a runbook for publishing a new go module.](demos/ask-runbook.gif)
![savvy record history](demos/savvy-history.gif)

2. Ask Savvy to help you with a tricky sequence of shell commands.
### Sharing Workflows

![Ask Savvy to help you with a tricky shell command](demos/ask-command.gif)
Workflows are private by default, but you can share them using a public or unlisted link from Savvy's dashboard.

You can also export workflows to markdown and paste them in your existing docs.

## Generate Runbooks using your commands
### Create Workflows with Savvy Record

Use `savvy record` or `savvy record history` to create a runbook using commands you provide.
`savvy record` starts a new shell and all commands in this shell are recorded and sent to an LLM to generate a workflow.

You don't have to change anything about your shell or aliases, savvy auto expands all aliases to make sure your runbook runs reliably on any machine.
![Savvy Workflow](https://vhs.charm.sh/vhs-1UmW0o6uSztF6b76y92K2K.gif)

### Create Runbooks from your Shell History
> [!NOTE]
> Creating a workflow with savvy record requires you to signup for a free account.
Use `savvy record history` to go back in time and create a runbooks by selecting just the commands you want.
## Automatically Run Workflows

Savvy will never execute any command you select.
Use `savvy run` to search and run workflows right from your terminal.

Savvy automatically fills in the next command to execute. Just press enter to run it.

![savvy record history](demos/savvy-history.gif)
![savvy run](demos/savvy-run.gif)

### Sharing Runbooks
## Workflow Placeholders

Runbooks are private by default, but you can share them using a public or unlisted link from Savvy's dashboard.
Parameterizing workflows is very easy with Savvy.

You can also export runbooks to markdown and paste them in your existing docs.
Replace hardcoded values with `<parameters>` from the dashboard for any step. Savvy takes care of the rest.

### Create Runbooks with Savvy Record
`savvy run` automatically detects any `<parameters>` and prompts users to fill in the value only once per parameter.

`savvy record` starts a new shell and all commands in this shell are recorded and sent to an LLM to generate a runbook.
![set param dashboard](demos/savvy-param-dashboard.jpeg)
![set param runtime](demos/savvy-param-run.jpeg)

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

> [!NOTE]
> Creating a runbook with savvy record requires you to signup for a free account.
Check our [docs for more details on workflow placeholders](https://docs.getsavvy.so/guides/placeholders/)

## Automatically Run Runbooks
## Sync Workflows

Use `savvy run` to search and run runbooks right from your terminal.
Use `savvy sync` to keep a local copy of your workflows. If you're ever offline or in bad network conditions, you can still run your workflows with `savvy run --local`

Savvy automatically fills in the next command to execute. Just press enter to run it.
![Savvy Sync](demos/savvy-sync.gif)

![savvy run](demos/savvy-run.gif)
## Generate Workflows with AI

## Runbook Parameterization
Use `savvy ask` to generate entire workflows or a single command using natural language.

Parameterizing runbooks is very easy with Savvy.
Just run `savvy ask` and provide a prompt.

Replace hardcoded values with `<parameters>` from the dashboard for any step. Savvy takes care of the rest.
Any one can use it, there's no need to signup for an account or provide a credit card.

`savvy run` automatically detects any `<parameters>` and prompts users to fill in the value only once per parameter.
### Examples

![set param dashboard](demos/savvy-param-dashboard.jpeg)
![set param runtime](demos/savvy-param-run.jpeg)
1. Ask Savvy to create a workflow for publishing a new go module.

![Ask Savvy to create a workflow for publishing a new go module.](demos/ask-workflow.gif)

Check our [docs for more details on runbook parameterization](https://docs.getsavvy.so/guides/parameterize_runbooks/)
2. Ask Savvy to help you with a tricky sequence of shell commands.

![Ask Savvy to help you with a tricky shell command](demos/ask-command.gif)

## Savvy Explain

Expand Down
Binary file added demos/savvy-sync.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b8cd27

Please sign in to comment.