Skip to content

Commit acd8ada

Browse files
committed
docs: update README.md
1 parent 008c70e commit acd8ada

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ This implementation was adapted from the [Model Context Protocol quickstart guid
5454
- 🌐 **Multi-Server Support**: Connect to multiple MCP servers simultaneously
5555
- 🚀 **Multiple Transport Types**: Supports STDIO, SSE, and Streamable HTTP server connections
5656
- 🎨 **Rich Terminal Interface**: Interactive console UI
57-
- 🖥️ **Streaming Responses**: View model outputs in real-time as they're generated
57+
- 🌊 **Streaming Responses**: View model outputs in real-time as they're generated
5858
- 🛠️ **Tool Management**: Enable/disable specific tools or entire servers during chat sessions
5959
- 🧑‍💻 **Human-in-the-Loop (HIL)**: Review and approve tool executions before they run for enhanced control and safety
6060
- 🎮 **Advanced Model Configuration**: Fine-tune 10+ model parameters including temperature, sampling, repetition control, and more
@@ -72,6 +72,7 @@ This implementation was adapted from the [Model Context Protocol quickstart guid
7272
- 📊 **Usage Analytics**: Track token consumption and conversation history metrics
7373
- 🔌 **Plug-and-Play**: Works immediately with standard MCP-compliant tool servers
7474
- 🔔 **Update Notifications**: Automatically detects when a new version is available
75+
- 🖥️ **Modern CLI with Typer**: Grouped options, shell autocompletion, and improved help output
7576

7677
## Requirements
7778

@@ -116,7 +117,16 @@ ollmcp
116117
117118
### Command-line Arguments
118119

119-
#### Server Options:
120+
> [!TIP]
121+
> The CLI now uses `Typer` for a modern experience: grouped options, rich help, and built-in shell autocompletion. To enable autocompletion, run:
122+
>
123+
> ```bash
124+
> ollmcp --install-completion
125+
> ```
126+
>
127+
> Then restart your shell or follow the printed instructions.
128+
129+
#### MCP Server Configuration:
120130
121131
- `--mcp-server`: Path to one or more MCP server scripts (.py or .js). Can be specified multiple times.
122132
- `--servers-json`: Path to a JSON file with server configurations.
@@ -126,11 +136,19 @@ ollmcp
126136
> Claude's configuration file is typically located at:
127137
> `~/Library/Application Support/Claude/claude_desktop_config.json`
128138
129-
#### Model Options:
139+
140+
#### Ollama Configuration:
130141
131142
- `--model MODEL`: Ollama model to use. Default: `qwen2.5:7b`
132143
- `--host HOST`: Ollama host URL. Default: `http://localhost:11434`
133144
145+
#### General Options:
146+
147+
- `--version`: Show version and exit
148+
- `--install-completion`: Install shell autocompletion scripts for the client
149+
- `--show-completion`: Show available shell completion options
150+
- `--help`: Show help message and exit
151+
134152
### Usage Examples
135153
136154
Connect to a single server:
@@ -322,6 +340,12 @@ What would you like to do? (y):
322340

323341
## Autocomplete and Prompt Features
324342

343+
### Typer Shell Autocompletion
344+
345+
- The CLI supports shell autocompletion for all options and arguments via Typer
346+
- To enable, run `ollmcp --install-completion` and follow the instructions for your shell
347+
- Enjoy tab-completion for all grouped and general options
348+
325349
### FZF-style Autocomplete
326350

327351
- Fuzzy matching for commands as you type
@@ -448,6 +472,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
448472
- [Model Context Protocol](https://modelcontextprotocol.io/) for the specification and examples
449473
- [Ollama](https://ollama.com/) for the local LLM runtime
450474
- [Rich](https://rich.readthedocs.io/) for the terminal user interface
475+
- [Typer](https://typer.tiangolo.com/) for the modern CLI experience
476+
- [UV](https://www.uvicorn.org/) for the lightning-fast Python package manager and virtual environment management
451477

452478
---
453479

0 commit comments

Comments
 (0)