Skip to content

Commit

Permalink
Include TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
barthr committed Apr 1, 2022
1 parent 5f5d1a0 commit 8efa633
Showing 1 changed file with 13 additions and 10 deletions.
23 changes: 13 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@

# Redo

Redo is an command line application to easily create reusable functions in your own shell. Think of redo like an interactive way combine multiple commands from history in a single command.
Redo is an command line application to easily create reusable functions in your own shell. Think of redo like an
interactive way combine multiple commands from history in a single command.

![demo](https://github.com/barthr/redo/blob/master/docs/demo.gif)

* [Features](#features)
* [Installation](#installation)
* [Prebuilt binaries](#prebuilt-binaries)
* [Install from source](#install-from-source)
* [Configuration](#configuration)
* [Roadmap](#roadmap)
* [License](#license)

## Features

- Easily create reusable functions from shell history
- Shell agnostic, can be used with ZSH, Bash etc.
- Aliases are stored in a single file which can be put in version control


## Installation

### Prebuilt binaries
Expand All @@ -21,7 +29,6 @@ Download one of the prebuilt binaries from: https://github.com/barthr/redo/relea
tar -xf <downloaded_archive> redo && sudo mv redo /usr/local/bin
```


### Install from source

```bash
Expand All @@ -30,7 +37,8 @@ go install github.com/barthr/redo@latest

## Configuration

Redo can mostly run without requiring any specific configuration, however it is possible to customize this configuration by setting the following environment variables:
Redo can mostly run without requiring any specific configuration, however it is possible to customize this configuration
by setting the following environment variables:

`REDO_ALIAS_PATH`: The path where the alias file of redo is stored (defaults to aliases file in user config dir)

Expand All @@ -40,18 +48,13 @@ Redo can mostly run without requiring any specific configuration, however it is

`REDO_EDITOR`: The editor you wan't to use when running commands like `redo edit` (defaults to EDITOR)





## Roadmap

- Reordering of selected tasks
- Easy listing/deletion of functions
- Inline editting of shell functions
- Prebuilt binaries published as .deb .rpm .yum etc.


## License

[MIT](https://choosealicense.com/licenses/mit/)
Expand Down

0 comments on commit 8efa633

Please sign in to comment.