Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FEAT(docs): Add Tab Autocomplete guide and alternatives #20

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions docs/tab-autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PearAI supports tab autocomplete, which predicts and suggests what you would typ

1. **Setup Codestral**

We recommend using Codestral, the leading model for code completion (or FIM — Fill In Middle). It's also open-sourced! You'll need to obtain a Codestral API key from [Mistral API](https://console.mistral.ai).
We recommend using [Codestral](https://mistral.ai/news/codestral/), the leading model for code completion (or FIM — Fill In Middle). It's also open-sourced! You'll need to obtain a Codestral API key from [Mistral API](https://console.mistral.ai).

2. **Add to PearAI config.json**

Expand All @@ -31,8 +31,28 @@ PearAI supports tab autocomplete, which predicts and suggests what you would typ

3. **Enjoy the development speed up with autocomplete!**

## Alternative
## Alternatives

- You can also use [Supermaven](https://supermaven.com/) for tab autocomplete. It is currently one of the best autocomplete AI on the market, and provides a free tier. You can get started by installing Supermaven directly as an extension within PearAI.
- You can enhance your tab autocomplete with [Supermaven](https://supermaven.com/). It is currently one of the best autocomplete AI on the market, and provides a free tier. You can get started by installing Supermaven directly as an extension within PearAI.

![Supermaven extension](../static/img/supermaven.png)

- Additionally, you can use [Ollama](https://ollama.ai/) local models by downloading the desired model and adding it to your configuration.

```json
"tabAutocompleteModel": {
"title": "StarCoder2",
"provider": "ollama",
"model": "starcoder2:latest"
},
{
"title": "Llama 3.2",
"provider": "ollama",
"model": "llama3.2:1b"
},
{
"title": "Qwen 2.5 Coder",
"provider": "ollama",
"model": "qwen2.5-coder:1.5b"
}
```