Skip to content

Commit bbde4d6

Browse files
committed
Generalised Readme
1 parent 6d229ed commit bbde4d6

1 file changed

Lines changed: 26 additions & 42 deletions

File tree

README.md

Lines changed: 26 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
# Claude CLI
1+
# AI CLI
22

3-
![Claude CLI Demo2](Demo3.gif)
3+
![CLI Demo2](Demo3.gif)
44

5-
![Claude CLI Demo](Resources/Demo.gif)
5+
![CLI Demo](Resources/Demo.gif)
66

7-
Command-line interface for interacting with Claude AI models.
7+
Command-line interface for interacting with AI models.
88

99
**Version:** 0.3.0 | **Python:** 3.8+ | **License:** MIT
1010

1111
## Overview
1212

13-
Claude CLI provides a seamless, terminal-based interface to interact with Anthropic's Claude AI models. It combines the power of Claude's advanced reasoning capabilities with the efficiency of a command-line workflow, perfect for developers, researchers, and power users.
13+
This CLI aapp provides a seamless, terminal-based interface to interact with various models. It combines the power of AI's advanced reasoning capabilities with the efficiency of a command-line workflow, perfect for developers, researchers, and power users.
1414

1515
## Features
1616

17-
- **Interactive Mode**: Engage in continuous conversations with Claude through a responsive terminal interface
17+
- **Interactive Mode**: Engage in continuous conversations with AI through a responsive terminal interface
1818
- **Command-Line Mode**: Quick queries without entering the interactive environment
1919
- **Variable System**: Persistent variables with simple assignment and interpolation (`name=John`, then use `name`)
2020
- **Vim-Style Key Bindings**: Familiar navigation and editing for power users
2121
- **Conversation Management**: Save, view, and clear conversation history
22-
- **File Upload Support**: Share files with Claude for analysis, with intelligent handling of both text and image files
22+
- **File Upload Support**: Share files with AI for analysis, with intelligent handling of both text and image files
2323
- **Rich Terminal UI**: Color-coded output and animated progress indicators
2424
- **Context Preservation**: Maintain conversation context for more coherent exchanges
2525
- **C++ API**: Cross-language variable access for integration
@@ -45,18 +45,18 @@ Claude CLI provides a seamless, terminal-based interface to interact with Anthro
4545

4646
```bash
4747
# Clone the repository
48-
git clone https://github.com/cschladetsch/PyClaudeCli.git
49-
cd PyClaudeCli
48+
# You have already done this
5049

51-
# Set up your API key
50+
# Set up your API key: eg:
5251
echo "your-anthropic-api-key" > ~/.claude_token
5352
# Or set environment variable: export CLAUDE_API_KEY="your-anthropic-api-key"
53+
# Or set environment variable: export AI_ENGINE_API_KEY="your-x-api-key"
5454

5555
# Build and test everything
5656
./b # Builds C++ components and runs all tests
5757

5858
# Run the CLI (dependencies will be auto-installed on first run)
59-
python3 main.py "Hello Claude!"
59+
python3 main.py "Hello Ai!"
6060
```
6161

6262
The application will automatically install required dependencies on first run if they're not already present.
@@ -68,18 +68,18 @@ To use the `ask` command from anywhere in your terminal, add an alias to your sh
6868
#### For Zsh (`.zshrc`)
6969

7070
```bash
71-
echo "alias ask=~/local/repos/PyClaudeCli/main.py" >> ~/.zshrc
71+
echo "alias ask=~/local/repos/PyCPyJsCppCli/main.py" >> ~/.zshrc
7272
source ~/.zshrc
7373
```
7474

7575
#### For Bash (`.bashrc`)
7676

7777
```bash
78-
echo "alias ask=~/local/repos/PyClaudeCli/main.py" >> ~/.bashrc
78+
echo "alias ask=~/local/repos/PPyJsCppCli/main.py" >> ~/.bashrc
7979
source ~/.bashrc
8080
```
8181

82-
Note: Adjust the path to match where you cloned the repository. The example above assumes the repository is in `~/local/repos/PyClaudeCli/`.
82+
Note: Adjust the path to match where you cloned the repository. The example above assumes the repository is in `~/local/repos/PyJsCppCli/`.
8383

8484
After setting up the alias, you can use the `ask` command from any directory.
8585

@@ -99,7 +99,7 @@ ask [options] [query]
9999
| `--version`, `-v` | Show version information |
100100
| `--reset` | Reset configuration to defaults |
101101
| `--init-config` | Create default config files in ~/.config/claude/ |
102-
| `--model MODEL` | Specify Claude model to use (e.g., claude-3-opus) |
102+
| `--model MODEL` | Specify model to use (e.g., claude-3-opus) |
103103
| `--no-spinner` | Disable loading spinner animation |
104104
| `--json` | Output response in JSON format |
105105
| `--config PATH` | Specify custom config file path |
@@ -119,7 +119,7 @@ Launch the interactive mode by running the command without arguments:
119119
ask
120120
```
121121

122-
This opens a prompt where you can chat with Claude continuously. The prompt is displayed as a magenta lambda symbol (λ).
122+
This opens a prompt where you can chat with Ai continuously. The prompt is displayed as a magenta lambda symbol (λ).
123123

124124
#### Available Commands in Interactive Mode
125125

@@ -216,17 +216,17 @@ ask --help
216216

217217
## File Handling
218218

219-
Claude CLI intelligently handles different file types:
219+
CLI intelligently handles different file types:
220220

221-
- **Text Files** (markdown, code, txt, etc.): Content is extracted and included directly in the message to Claude
222-
- **Image Files** (jpeg, png, gif, webp): Sent as attachments via the Claude API
221+
- **Text Files** (markdown, code, txt, etc.): Content is extracted and included directly in the message to Ai
222+
- **Image Files** (jpeg, png, gif, webp): Sent as attachments via the AI API
223223
- **Unsupported Files**: Warning message is displayed, and file is skipped
224224

225225
## Configuration
226226

227227
### API Key
228228

229-
You can provide your Claude API key in either of two ways:
229+
You can provide your AI API key in either of two ways:
230230

231231
1. **Environment Variable**:
232232
```bash
@@ -240,7 +240,7 @@ You can provide your Claude API key in either of two ways:
240240

241241
### Configuration Directory
242242

243-
Claude CLI uses `~/.config/claude/` for user customization. To create default configuration files:
243+
CLI uses `~/.config/claude/` for user customization. To create default configuration files:
244244

245245
```bash
246246
ask --init-config
@@ -259,7 +259,7 @@ This creates the following files:
259259

260260
#### Custom System Prompt
261261

262-
Edit `~/.config/claude/system` to customize Claude's behavior:
262+
Edit `~/.config/claude/system` to customize AI's behavior:
263263

264264
```bash
265265
echo "You are a helpful coding assistant specializing in Python" > ~/.config/claude/system
@@ -380,7 +380,7 @@ make
380380

381381
### Using with Unix Pipes
382382

383-
Claude CLI works well with Unix pipes, allowing integration into complex workflows:
383+
AI CLI works well with Unix pipes, allowing integration into complex workflows:
384384

385385
```bash
386386
# Analyze the output of a command
@@ -413,26 +413,14 @@ The Ask CLI follows a layered architecture with clear separation of concerns:
413413
- **Entry Points**: Multiple ways to launch the application
414414
- **CLI Layer**: Command parsing and routing
415415
- **Interaction Modes**: Interactive, async, and command-line modes
416-
- **API Layer**: Claude API integration with connection pooling
416+
- **API Layer**: AI API integration with connection pooling
417417
- **Plugin System**: Extensible architecture for custom functionality
418418
- **Utilities**: Configuration, validation, logging, and streaming support
419419

420420
## Project Structure
421421

422422
```
423-
PyClaudeCli/
424-
├── main.py # Primary entry point
425-
├── ai/ # Main package
426-
│ ├── __main__.py # Module entry point
427-
│ ├── cli.py # CLI handling logic
428-
│ ├── constants.py # Configuration constants
429-
│ ├── models.py # Data models
430-
│ ├── api/ # API clients
431-
│ │ ├── client.py # Sync Claude API client
432-
│ │ └── async_client.py # Async Claude API client
433-
│ ├── modes/ # Interaction modes
434-
│ │ ├── interactive.py # Interactive mode
435-
│ │ └── async_interactive.py # Async interactive mode
423+
py # Async interactive mode
436424
│ ├── bindings/ # C++ API bindings
437425
│ │ ├── variable_api.cpp # C++ variable interface
438426
│ │ └── CMakeLists.txt # C++ build configuration
@@ -516,9 +504,5 @@ This project is licensed under the MIT License - see the LICENSE file for detail
516504

517505
## Acknowledgments
518506

519-
- [Anthropic](https://www.anthropic.com/) for creating Claude
520-
- The Python community for excellent libraries like prompt_toolkit
507+
- The Python community for excellent libraries like prompt\_toolkit
521508

522-
---
523-
524-
*Made with ❤️ for the Claude community*

0 commit comments

Comments
 (0)