Skip to content

Commit

Permalink
Add alias for rubcd
Browse files Browse the repository at this point in the history
  • Loading branch information
jotadrilo committed Jun 18, 2019
1 parent ac6f2b8 commit 791f677
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is a Go and Shell tool that provides a sandbox directory for rubbish.
If you usually run tons of commands that generate garbage, wherever you are, you need an easy way to access a temporary folder where to run these tasks.

```
> jotadrilo @ ~ $ rubcd # or `r` or `rubbish`
> jotadrilo @ ~ $ rbsh # or `rubcd` or `r` or `rubbish`
> jotadrilo @ /tmp/rubbish/20190614 $
```

Expand Down Expand Up @@ -38,15 +38,16 @@ sudo bash -c 'cd rubbi-sh; ./install.sh'

## Examples

### rubcd
### rbsh

This is the core functionality. You will get a sandbox for your rubbish and will get `cd`ed to it. This sandbox will be re-created every day and will keep old ones until you reboot your device (they are stored at `/tmp` by default).

```
> jotadrilo @ ~ $ rubcd
> jotadrilo @ ~ $ rbsh
> jotadrilo @ /tmp/rubbish/20190614 $
```

> **NOTE**: Alias: `rubcd`, `rubbish`, `r`
> **NOTE**: During the first run, it will create a new configuration file at `$HOME/.rubbish`. Example:
> ```
> > jotadrilo @ ~ $ cat ~/.rubbish/config.json
Expand All @@ -65,14 +66,6 @@ This is the core functionality. You will get a sandbox for your rubbish and will
> }
> ```
### rubbish
This is an alias for `rubcd`
### r
This is an alias for `rubcd`
### rubshow
This helper will show the list of rubbish folders.
Expand Down

0 comments on commit 791f677

Please sign in to comment.