first commit

USAGE.md

@@ -0,0 +1,140 @@
+# Usage Guide
+
+## Installation
+
+Install and set up finishte:
+
+```bash
+finishte install
+source ~/.bashrc
+```
+
+## Configuration
+
+View current settings:
+
+```bash
+finishte config
+```
+
+Change settings:
+
+```bash
+finishte config set temperature 0.5
+finishte config set endpoint http://localhost:1234/v1/chat/completions
+finishte config set model your-model-name
+```
+
+Reset to defaults:
+
+```bash
+finishte config reset
+```
+
+## Model Selection
+
+Select a model interactively:
+
+```bash
+finishte model
+```
+
+Use arrow keys to navigate, Enter to select, or 'q' to quit.
+
+## Basic Commands
+
+Show help:
+
+```bash
+finishte --help
+```
+
+Test completions without caching:
+
+```bash
+finishte command "your command here"
+```
+
+Preview the prompt sent to the model:
+
+```bash
+finishte command --dry-run "your command here"
+```
+
+View system information:
+
+```bash
+finishte system
+```
+
+## Usage Statistics
+
+Check your usage stats and costs:
+
+```bash
+finishte usage
+```
+
+## Cache Management
+
+Clear cached completions and logs:
+
+```bash
+finishte clear
+```
+
+## Enable/Disable
+
+Temporarily disable:
+
+```bash
+finishte disable
+```
+
+Re-enable:
+
+```bash
+finishte enable
+```
+
+## Uninstallation
+
+Remove finishte completely:
+
+```bash
+finishte remove
+```
+
+## Using finishte
+
+Once enabled, just type a command and press `Tab` twice to get suggestions:
+
+```bash
+git <TAB><TAB>
+docker <TAB><TAB>
+find <TAB><TAB>
+```
+
+Natural language also works:
+
+```bash
+# convert video to mp4 <TAB><TAB>
+# list all processes using port 8080 <TAB><TAB>
+# compress this folder to tar.gz <TAB><TAB>
+```
+
+## Configuration File
+
+The config file is located at `~/.finishte/config` and contains:
+
+- `provider`: Model provider (lmstudio, ollama)
+- `model`: Model name
+- `temperature`: Response randomness (0.0 - 1.0)
+- `endpoint`: API endpoint URL
+- `api_prompt_cost`: Cost per input token
+- `api_completion_cost`: Cost per output token
+- `max_history_commands`: Number of recent commands to include in context
+- `max_recent_files`: Number of recent files to include in context
+- `cache_dir`: Directory for cached completions
+- `cache_size`: Maximum number of cached items
+- `log_file`: Path to usage log file