Skip to content

Commit

Permalink
Update README.md - formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
closedLoop authored Jul 23, 2024
1 parent 67c3678 commit f5e4b25
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,6 @@ Autocomplete.sh
* **Caching**: By default we cache the last 20 queries for convience and speed: `autocomplete config`
* **Cost Monitoring**: The size and costs of each API call is logged. `autocomplete usage`

### Tips and Tricks

1. If you know the command you need, but forget the parameters: Write this: `ffmpeg # reformat video to fit youtube` Then type **<TAB><TAB>**
2. To set more out of a single command: Write this: `# create a github repo, init a readme, and push it to the github` Then type **<TAB><TAB>**

If all is going well, you should see a flashing green cursor as it queries the LLM API.

**Debugging:**
If the last word in your command is a filename or common command, bash will try to use standard bash_completion scripts and will not trigger `autocomplete`. To combat this I suggest writing another word after the command (like "Please") or putting most of the line in quotes.

Currently this only supports **`bash`**. If you have additional problems, please file an [issue](https://github.com/closedloop-technologies/autocomplete-sh/issues)

## Installation

```bash
Expand Down Expand Up @@ -66,6 +54,18 @@ autocomplete command --dry-run "anything you want here"

By default we cache the last 20 requests to reduce latency and costs.

### Tips and Tricks

1. If you know the command you need, but forget the parameters: Write this: `ffmpeg # reformat video to fit youtube` Then type **<TAB><TAB>**
2. To set more out of a single command: Write this: `# create a github repo, init a readme, and push it to the github` Then type **<TAB><TAB>**

If all is going well, you should see a flashing green cursor as it queries the LLM API.

**Debugging:**
If the last word in your command is a filename or common command, bash will try to use standard bash_completion scripts and will not trigger `autocomplete`. To combat this I suggest writing another word after the command (like "Please") or putting most of the line in quotes.

Currently this only supports **`bash`**. If you have additional problems, please file an [issue](https://github.com/closedloop-technologies/autocomplete-sh/issues)

### Configuration

```bash
Expand Down

0 comments on commit f5e4b25

Please sign in to comment.