miii-cli 0.1.0 → 0.1.2

package/.claude/settings.local.json

@@ -12,7 +12,8 @@
       "Bash(npm whoami *)",
       "Bash(npm run *)",
       "Bash(npm publish *)",
-      "Bash(npm pkg *)"
+      "Bash(npm pkg *)",
+      "Bash(npm version *)"
     ]
   }
 }

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 maruakshay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,120 +1,122 @@
-# miii
+# miii-cli
+
+> Local AI coding assistant for your terminal. No cloud. No API keys. No latency.
 
 ```
-╭─ MIII - CLI ───────────────────────────────────────────╮
-│  Claude Code-level terminal workflows, local models.   │
-╰────────────────────────────────────────────────────────╯
+╭─────────────────────────────────────────────────────────╮
+│  miii — Claude Code-level workflows, local models only  │
+╰─────────────────────────────────────────────────────────╯
 ```
 
-A fast, local AI coding assistant that runs entirely on your machine.
-No cloud. No API keys. Just you, your terminal, and whatever model you pull.
+[![npm version](https://img.shields.io/npm/v/miii-cli)](https://www.npmjs.com/package/miii-cli)
+[![license](https://img.shields.io/npm/l/miii-cli)](LICENSE)
+[![node](https://img.shields.io/node/v/miii-cli)](https://nodejs.org)
 
 ---
 
-## Install
-
-```bash
-npm install -g miii-cli
-```
+## What is miii?
 
-Or run from source:
+`miii` is a terminal-native AI coding assistant powered by local models via [Ollama](https://ollama.com) or any OpenAI-compatible API (LM Studio, vLLM, Groq, Together, etc.).
 
-```bash
-git clone https://github.com/maruakshay/miii-cli
-cd miii-cli
-npm install
-npm run build
-npm link
-```
+- **Runs 100% locally** — your code never leaves your machine
+- **File-aware** — type `@filename` to inject any file into context instantly
+- **Tool-enabled** — reads, writes, edits, and runs shell commands autonomously
+- **Session memory** — conversations persist across launches
+- **Extensible** — add custom slash commands via Markdown or TypeScript skill files
 
 ---
 
-## Quick start
+## Install
 
 ```bash
-miii                        # start with default session
-miii --model codellama      # use a specific model
-miii --session myproject    # start in a named session
-miii -s work -m llama3.2    # short flags
+npm install -g miii-cli
 ```
 
-On startup, miii opens the model picker — pick a model and start coding.
+**Requirements:** Node.js 18+ and [Ollama](https://ollama.com) (or any OpenAI-compatible API)
 
 ---
 
-## Commands
+## Quick start
 
-Type `/` to open the command palette and browse everything.
+```bash
+# Make sure Ollama is running
+ollama serve
 
-| Command | What it does |
-|---|---|
-| `/models` | Open model picker — switch or pull Ollama models |
-| `/clear` | Clear current session's chat history |
-| `/sessions` | List all saved sessions |
-| `/session <name>` | Switch to (or create) a named session |
-| `/list` | List all loaded skills |
-| `/exit` | Exit miii |
+# Start miii
+miii
+```
+
+On launch, miii opens a model picker. Select a model and start coding.
 
-Skills loaded from `~/.config/miii/skills/` appear in the palette too.
+```bash
+miii                          # default session
+miii --model codellama        # specific model
+miii --session myproject      # named session
+miii -s work -m llama3.2      # short flags
+```
 
 ---
 
 ## File context with `@`
 
-Type `@` anywhere in your message to fuzzy-find project files and inject their content into the LLM context.
+Type `@` anywhere in your message to fuzzy-search and inject project files into the model's context:
 
 ```
 ❯ review the auth logic in @src/auth/middleware.ts
+❯ refactor @src/utils/parser.ts to handle edge cases
 ```
 
-The file content is injected automatically — the model sees the full source.
-
-Filtered automatically: `node_modules`, `dist`, `.git`, lock files, binaries, images.
+Automatically excluded: `node_modules`, `dist`, `.git`, lock files, binaries, images.
 
 ---
 
-## Sessions
-
-Every conversation is saved. Sessions persist between launches.
-
-```bash
-miii                          # continues "default" session
-miii --session feature-auth   # continues or creates "feature-auth"
-```
+## Built-in commands
 
-Mid-conversation:
+Type `/` to open the command palette.
 
-```
-/session feature-auth    switch sessions
-/sessions                see all sessions with message counts
-/clear                   wipe current session history
-```
-
-Sessions stored at `~/.config/miii/sessions/`.
+| Command | Description |
+|---|---|
+| `/models` | Switch or pull Ollama models |
+| `/session <name>` | Switch to or create a named session |
+| `/sessions` | List all sessions with message counts |
+| `/clear` | Clear current session history |
+| `/list` | Show loaded skills |
+| `/exit` | Exit miii |
 
 ---
 
-## Tools
+## Built-in tools
 
-miii has built-in file and shell tools the model can use automatically:
+The model can call these tools automatically — no setup needed.
 
-| Tool | What it does |
+| Tool | Description |
 |---|---|
 | `read_file` | Read any file |
 | `list_files` | List directory contents |
 | `edit_file` | Create or overwrite a file |
 | `delete_file` | Delete a file |
-| `run_command` | Run a shell command in cwd |
+| `run_command` | Run a shell command in the current directory |
 
-The model calls these via `<tool_call>` tags, miii executes them and feeds results back automatically — up to 6 hops deep.
+Tool calls chain up to 6 hops deep — the model reads, edits, runs, and verifies on its own.
 
 ---
 
-## Skills
+## Sessions
+
+Every conversation is saved and resumed automatically.
+
+```bash
+miii                          # resumes "default" session
+miii --session feature-auth   # resumes or creates "feature-auth"
+```
+
+Sessions stored at `~/.config/miii/sessions/`.
 
-Skills are custom commands you can invoke with `/`.
+---
+
+## Skills
 
-Create `~/.config/miii/skills/review.md`:
+Skills are custom `/` commands. Create a Markdown file in `~/.config/miii/skills/`:
 
 ```markdown
 ---
@@ -126,7 +128,7 @@ Review the code I'm about to share. Look for bugs, edge cases, and improvements.
 Be direct and specific. No markdown.
 ```
 
-Then use it:
+Use it:
 
 ```
 /review
@@ -138,10 +140,11 @@ Skills can also be TypeScript files with an `execute` function for programmatic
 
 ## Configuration
 
-miii looks for config in:
+Config is loaded from (in order):
 1. `.miii.json` in the current directory
 2. `~/.config/miii/config.json`
 
+**Ollama (default):**
 ```json
 {
   "model": "llama3.2",
@@ -150,8 +153,7 @@ miii looks for config in:
 }
 ```
 
-For OpenAI-compatible APIs:
-
+**OpenAI-compatible API:**
 ```json
 {
   "model": "gpt-4o",
@@ -160,14 +162,7 @@ For OpenAI-compatible APIs:
 }
 ```
 
-Works with any OpenAI-compatible server: LM Studio, vLLM, Groq, Together, etc.
-
----
-
-## Requirements
-
-- Node.js 18+
-- [Ollama](https://ollama.com) (or any OpenAI-compatible API)
+Works with LM Studio, vLLM, Groq, Together, and any other OpenAI-compatible server.
 
 ---
 
@@ -176,7 +171,19 @@ Works with any OpenAI-compatible server: LM Studio, vLLM, Groq, Together, etc.
 | Key | Action |
 |---|---|
 | `enter` | Send message |
-| `ctrl+c` | Abort streaming |
-| `ctrl+c` x2 | Exit |
-| `esc` | Close overlay / abort |
-| `↑ ↓` | Navigate command palette or file picker |
+| `ctrl+c` | Abort streaming response |
+| `ctrl+c` x2 | Exit miii |
+| `esc` | Close overlay or abort |
+| `↑ / ↓` | Navigate command palette or file picker |
+
+---
+
+## Source
+
+```bash
+git clone https://github.com/maruakshay/miii-cli
+cd miii-cli
+npm install
+npm run build
+npm link
+```

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "miii-cli",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "type": "module",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
   "bin": {
     "miii": "dist/index.js"
   },
@@ -12,17 +16,17 @@
     "link": "npm run build && npm link"
   },
   "dependencies": {
-    "ink": "^5.2.0",
-    "react": "^18.3.1",
     "diff": "^7.0.0",
     "glob": "^11.0.1",
-    "minimist": "^1.2.8"
+    "ink": "^5.2.0",
+    "minimist": "^1.2.8",
+    "react": "^18.3.1"
   },
   "devDependencies": {
-    "@types/node": "^22.10.0",
-    "@types/react": "^18.3.1",
     "@types/diff": "^7.0.0",
     "@types/minimist": "^1.2.5",
+    "@types/node": "^22.10.0",
+    "@types/react": "^18.3.1",
     "tsx": "^4.19.1",
     "typescript": "^5.7.3"
   }