@iamharshil/aix-cli 1.0.2 → 1.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024
+Copyright (c) 2026 Harshil
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,43 +1,56 @@
 # AIX CLI
 
-> AI CLI tool that integrates LM Studio with Claude Code for enhanced development assistance
+> AI-powered CLI tool that integrates LM Studio with Claude Code for enhanced local development assistance
+
+<div align="center">
 
 [![npm version](https://img.shields.io/npm/v/@iamharshil/aix-cli.svg)](https://www.npmjs.com/package/@iamharshil/aix-cli)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org/)
+[![GitHub Release](https://img.shields.io/github/v/release/iamharshil/aix-cli)](https://github.com/iamharshil/aix-cli/releases)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/iamharshil/aix-cli/ci)](https://github.com/iamharshil/aix-cli/actions)
+[![Total Downloads](https://img.shields.io/npm/dt/@iamharshil/aix-cli)](https://www.npmjs.com/package/@iamharshil/aix-cli)
+
+</div>
+
+---
 
-**AIX** lets you use locally running AI models from LM Studio directly with Claude Code. No API keys, no cloud dependencies, complete privacy.
+## Overview
 
-## Features
+**AIX CLI** enables you to use locally-running AI models from [LM Studio](https://lmstudio.ai) directly with [Claude Code](https://docs.anthropic.com/en/docs/claude-code). No API keys, no cloud dependencies, complete privacy.
 
-- **Privacy-first**: All processing happens locally on your machine
-- **Permission-based**: Never makes system changes without asking
-- **Interactive model selection**: Browse and choose from your downloaded models
-- **Seamless Claude Code integration**: Just run `aix-cli run` and code
-- **Cross-platform**: macOS, Linux, and Windows support
+### Why AIX?
+
+| Feature              | Description                                    |
+| -------------------- | ---------------------------------------------- |
+| 🔒 **Privacy-First** | All processing happens locally on your machine |
+| 🔑 **No API Keys**   | No external services or subscriptions          |
+| 🚀 **Fast**          | Local inference with your GPU                  |
+| 🛡️ **Secure**        | Your code never leaves your machine            |
+| 🔧 **Simple**        | Just run `aix-cli run` and start coding        |
 
 ## Prerequisites
 
 - [Node.js](https://nodejs.org/) 18.0.0 or higher
-- [LM Studio](https://lmstudio.ai) - Download and install
-- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) - Install via `npm install -g @anthropic-ai/claude-code`
+- [LM Studio](https://lmstudio.ai) - Download and run local AI models
+- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) - AI coding assistant
 
 ## Quick Start
 
 ```bash
-# Install AIX CLI
+# Install
 npm install -g @iamharshil/aix-cli
 
-# Check if everything is set up
+# Verify setup
 aix-cli doctor
 
-# Start using (will prompt for model selection)
+# Run with interactive model selection
 aix-cli run
 ```
 
 ## Installation
 
-### Using npm (recommended)
+### Using npm (Recommended)
 
 ```bash
 npm install -g @iamharshil/aix-cli
@@ -55,7 +68,7 @@ yarn global add @iamharshil/aix-cli
 pnpm add -g @iamharshil/aix-cli
 ```
 
-### From source
+### From Source
 
 ```bash
 git clone https://github.com/iamharshil/aix-cli.git
@@ -69,56 +82,36 @@ npm link
 
 ### System Check
 
-Verify your setup:
+Verify your environment is properly configured:
 
 ```bash
 aix-cli doctor
 ```
 
-Output:
-
-```
-System Check
-──────────────────────────────────────────────────
-  ✓ LM Studio: Running
-  ✓ Claude Code: Installed
-
-Configuration
-──────────────────────────────────────────────────
-  ▸ LM Studio URL: http://localhost:1234
-```
-
-### Initialize & Load a Model
+### Initialize Model
 
-Select and load a model from your local LM Studio models:
+Load a model from your local LM Studio models:
 
 ```bash
+# Interactive selection
 aix-cli init
-```
-
-With a specific model:
 
-```bash
+# Specific model
 aix-cli init -m llama-3-8b
 ```
 
-### Run Claude Code with a Model
+### Run Claude Code
 
-Start an interactive Claude Code session with your selected model:
+Start coding with Claude Code and your local model:
 
 ```bash
+# Interactive session
 aix-cli run
-```
 
-With a specific model:
-
-```bash
+# With specific model
 aix-cli run -m llama-3-8b
-```
-
-With additional Claude Code arguments:
 
-```bash
+# With arguments
 aix-cli run -m llama-3-8b -- "Write a hello world in Python"
 ```
 
@@ -132,16 +125,18 @@ aix-cli status
 
 ## Configuration
 
+### Config Location
+
 AIX CLI stores configuration in your system's app data directory:
 
-- **macOS**: `~/Library/Application Support/aix-cli/`
-- **Linux**: `~/.config/aix-cli/`
-- **Windows**: `%APPDATA%\aix-cli\`
+| Platform | Path                                     |
+| -------- | ---------------------------------------- |
+| macOS    | `~/Library/Application Support/aix-cli/` |
+| Linux    | `~/.config/aix-cli/`                     |
+| Windows  | `%APPDATA%\aix-cli\`                     |
 
 ### Config File
 
-The config is stored as `config.json`:
-
 ```json
 {
   "lmStudioUrl": "http://localhost",
@@ -157,90 +152,87 @@ The config is stored as `config.json`:
 | ---------------- | --------------------- | ------- |
 | `LM_STUDIO_PORT` | LM Studio server port | `1234`  |
 
-## How It Works
+## Architecture
 
 ```
-┌─────────────────────────────────────────────────────────────┐
-│                        AIX Flow                            │
-├─────────────────────────────────────────────────────────────┤
-│                                                             │
-│   ┌──────────┐     ┌──────────────┐     ┌─────────────┐  │
-│   │   User   │────▶│  LM Studio   │────▶│   Models    │  │
-│   └──────────┘     └──────────────┘     └─────────────┘  │
-│        │                  │                                  │
-│        │                  ▼                                  │
-│        │           ┌──────────────┐                        │
-│        │           │  Local API   │                        │
-│        │           │  (port 1234) │                        │
-│        │           └──────────────┘                        │
-│        │                  │                                  │
-│        ▼                  ▼                                  │
-│   ┌──────────────────────────────┐                         │
-│   │       Claude Code            │                         │
-│   │  --model lmstudio/model-id   │                         │
-│   └──────────────────────────────┘                         │
-│                                                             │
-└─────────────────────────────────────────────────────────────┘
+┌─────────────────────────────────────────────────────┐
+│                     AIX Flow                        │
+├─────────────────────────────────────────────────────┤
+│                                                      │
+│   ┌──────────┐     ┌──────────────┐                │
+│   │   User   │────▶│  LM Studio   │                │
+│   └──────────┘     └──────────────┘                │
+│        │                  │                         │
+│        │                  ▼                         │
+│        │           ┌──────────────┐                 │
+│        │           │  Local API   │                 │
+│        │           │  (port 1234) │                 │
+│        │           └──────────────┘                 │
+│        │                  │                         │
+│        ▼                  ▼                         │
+│   ┌─────────────────────────────────┐              │
+│   │        Claude Code              │              │
+│   │    --model lmstudio/model      │              │
+│   └─────────────────────────────────┘              │
+│                                                      │
+└─────────────────────────────────────────────────────┘
 ```
 
 ## Troubleshooting
 
-### "LM Studio server is not running"
-
-1. Open LM Studio
-2. Go to the **Server** tab (left sidebar)
-3. Click **Start Server**
-4. Run `aix run` again
-
-Or let AIX start it for you (it will ask for permission).
-
-### "No models found"
+### LM Studio server not running
 
-1. Open LM Studio
-2. Go to the **Search** tab
-3. Download a model (e.g., Llama 3, Mistral, Phi-3)
-4. Wait for download to complete
-5. Run `aix init` or `aix run` again
+```bash
+# 1. Open LM Studio
+# 2. Go to Server tab (left sidebar)
+# 3. Click Start Server
+# 4. Run: aix-cli run
+```
 
-### "Claude Code is not installed"
+### No models found
 
 ```bash
-npm install -g @anthropic-ai/claude-code
+# 1. Open LM Studio
+# 2. Go to Search tab
+# 3. Download a model (e.g., Llama 3, Mistral)
+# 4. Wait for download to complete
+# 5. Run: aix-cli init
 ```
 
-### "Connection refused" on port 1234
+### Connection refused on port 1234
 
-The default port might be in use. Check LM Studio's server tab for the correct port, then update your config if needed.
+Check LM Studio's server tab for the correct port and update your config.
 
-## Privacy
+## Security & Privacy
 
-- All AI processing happens locally on your machine
-- No data is sent to external servers
-- No telemetry or analytics
-- No API keys required
-- Your code stays on your machine
+- ✅ All AI processing happens locally
+- ✅ No data sent to external servers
+- ✅ No telemetry or analytics
+- ✅ No API keys required
+- ✅ Your code stays on your machine
 
 ## Contributing
 
-Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) before submitting PRs.
+Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md).
 
-### Development Setup
+### Development
 
 ```bash
-# Clone the repository
-git clone https://github.com/your-username/aix.git
-cd aix
-
-# Install dependencies
+# Clone and setup
+git clone https://github.com/iamharshil/aix-cli.git
+cd aix-cli
 npm install
 
-# Run in development mode
+# Development mode
 npm run dev
 
 # Run tests
 npm test
 
-# Build for production
+# Lint
+npm run lint
+
+# Build
 npm run build
 ```
 
@@ -258,15 +250,17 @@ npm run build
 
 ## License
 
-MIT License - see [LICENSE](LICENSE) for details.
+[MIT](LICENSE) - © 2024 Harshil
 
 ## Support
 
-- [Issue Tracker](https://github.com/your-username/aix/issues) - Report bugs or request features
-- [Discussions](https://github.com/your-username/aix/discussions) - Ask questions and share ideas
+- 📋 [Issues](https://github.com/iamharshil/aix-cli/issues) - Report bugs
+- 💬 [Discussions](https://github.com/iamharshil/aix-cli/discussions) - Ask questions
 
 ---
 
-<p align="center">
-  Made with ❤️ for developers who value privacy
-</p>
+<div align="center">
+
+Built with ❤️ for privacy-conscious developers
+
+</div>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iamharshil/aix-cli",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "AI CLI tool that integrates LM Studio with Claude Code for enhanced development assistance",
   "keywords": [
     "cli",
@@ -42,7 +42,8 @@
     "test:watch": "vitest",
     "lint": "eslint src --ext .ts",
     "format": "prettier --write \"src/**/*.ts\"",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "audit": "node scripts/audit.js"
   },
   "dependencies": {
     "chalk": "^5.3.0",