edu4rdshl/based.fish
1
0
Fork 0
mirror of https://github.com/edu4rdshl/based.fish.git synced 2026-07-17 23:24:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

(chore): update documentation fdor new implemented features

Browse source
This commit is contained in:
Eduard Tolosa 2025-07-26 22:25:40 -05:00
parent 768bce39ec
commit 62cd9b2f17
1 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -68,12 +68,20 @@ $ based stats
``` ```
This will display statistics about your command usage, such as the most frequently used commands, options, and arguments. This will display statistics about your command usage, such as the most frequently used commands, options, and arguments.
For database maintenance (recommended to run if you notice performance issues):
```fish
$ based maintenance
```
This will optimize the database by running VACUUM and ANALYZE operations to keep it performing well.
## Configuration ## Configuration
You can customize the behavior of based.fish by setting environment variables in your Fish shell: You can customize the behavior of based.fish by setting environment variables in your Fish shell:
- `BASED_NO_CONFIRMATION`: If set to `1`, automatically executes the selected suggestion without confirmation, otherwise, it requires another Enter key press to execute the suggestion. - `BASED_NO_CONFIRMATION`: If set to `1`, automatically executes the selected suggestion without confirmation, otherwise, it requires another Enter key press to execute the suggestion.
- `BASED_NO_FUZZY`: If set to `1`, disables fuzzy matching for completions and only commands that start with the typed prefix will be suggested. - `BASED_NO_FUZZY`: If set to `1`, disables fuzzy matching for completions and only commands that start with the typed prefix will be suggested.
- `BASED_EXCLUDED_PATHS`: A list of path patterns to exclude from history logging. Supports glob patterns like `*` and `?`. Useful for excluding temporary directories, sensitive locations, or paths where you don't want command history tracked.
E.g. to disable fuzzy behavior when searching for completions E.g. to disable fuzzy behavior when searching for completions
@ -81,6 +89,12 @@ E.g. to disable fuzzy behavior when searching for completions
$ set -Ux BASED_NO_FUZZY 1 $ set -Ux BASED_NO_FUZZY 1
``` ```
E.g. to exclude specific paths from history tracking
```fish
$ set -Ux BASED_EXCLUDED_PATHS "/tmp/*" "/var/tmp/*" "$HOME/Downloads"
```
The keybindings for the completions are as follows: The keybindings for the completions are as follows:
- `Arrow Up` and `Arrow Down`: Navigate through the suggestions of the smart history. - `Arrow Up` and `Arrow Down`: Navigate through the suggestions of the smart history.