Revise README formatting and content
Updated README to correct formatting, improve clarity, and remove examples.
This commit is contained in:
parent
e4965f9368
commit
1b9e3b6347
1 changed files with 5 additions and 26 deletions
31
README.md
31
README.md
|
|
@ -1,14 +1,11 @@
|
||||||
# klod
|
# Klod
|
||||||
|
|
||||||
A simple, fast CLI tool for chatting with Claude using the Anthropic API with real-time streaming responses.
|
A simple, fast CLI tool for chatting with Claude using the Anthropic API with real-time streaming responses.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Interactive chat with Claude in your terminal
|
|
||||||
- Real-time streaming responses (see text as Claude types)
|
|
||||||
- Maintains conversation history within a session
|
- Maintains conversation history within a session
|
||||||
- Configurable model and system prompts
|
- Configurable model and system prompts
|
||||||
- Multi-location config file support
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -19,9 +16,9 @@ A simple, fast CLI tool for chatting with Claude using the Anthropic API with re
|
||||||
|
|
||||||
1. Clone and build:
|
1. Clone and build:
|
||||||
```bash
|
```bash
|
||||||
git clone <your-repo-url>
|
git clone https://github.com/leoalho/klod.git
|
||||||
cd anthropic-cli
|
cd anthropic-cli
|
||||||
go build -o klod
|
go build
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Create a symlink for global access:
|
2. Create a symlink for global access:
|
||||||
|
|
@ -65,7 +62,7 @@ EOF
|
||||||
|
|
||||||
Start a conversation:
|
Start a conversation:
|
||||||
```bash
|
```bash
|
||||||
klod "Hello, how are you?"
|
klod Hello, how are you?
|
||||||
```
|
```
|
||||||
|
|
||||||
This will:
|
This will:
|
||||||
|
|
@ -75,27 +72,9 @@ This will:
|
||||||
|
|
||||||
Type `exit` or `quit` to end the conversation.
|
Type `exit` or `quit` to end the conversation.
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Ask a quick question
|
|
||||||
klod "What is the capital of France?"
|
|
||||||
|
|
||||||
# Start a coding session
|
|
||||||
klod "Help me write a Python function to calculate fibonacci numbers"
|
|
||||||
|
|
||||||
# Use a different model (set in config)
|
|
||||||
# Edit your config file and change MODEL=claude-opus-4-5-20251101
|
|
||||||
klod "Explain quantum computing"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
Run without building:
|
Run without building:
|
||||||
```bash
|
```bash
|
||||||
go run main.go "your message here"
|
go run main.go your message here
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue